From a03314bacf4a523f74322070eaa42c9fedcb7740 Mon Sep 17 00:00:00 2001 From: David Schleef Date: Mon, 18 Mar 2002 23:47:48 +0000 Subject: [PATCH] Added info about the documentation comment block --- comedi/drivers/skel.c | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/comedi/drivers/skel.c b/comedi/drivers/skel.c index b0f54abc..f506705a 100644 --- a/comedi/drivers/skel.c +++ b/comedi/drivers/skel.c @@ -25,11 +25,44 @@ Driver: skel.o Description: Skeleton driver, an example for driver writers Devices: Author: ds +Updated: Mon, 18 Mar 2002 15:34:01 -0800 +Status: works This driver is a documented example on how Comedi drivers are written. + +Configuration Options: + none */ +/* + * The previous block comment is used to automatically generate + * documentation in Comedi and Comedilib. The fields: + * + * Driver: the name of the driver + * Description: a short phrase describing the driver. Don't list boards. + * Devices: a full list of the boards that attempt to be supported by + * the driver. Format is "(manufacturer) board name [comedi name]", + * where comedi_name is the name that is used to configure the board. + * See the comment near board_name: in the comedi_driver structure + * below. If (manufacturer) or [comedi name] is missing, the previous + * value is used. + * Author: you + * Updated: date when the _documentation_ was last updated. Use 'date -R' + * to get a value for this. + * Status: a one-word description of the status. Valid values are: + * works - driver works correctly on most boards supported, and + * passes comedi_test. + * unknown - unknown. Usually put there by ds. + * experimental - may not work in any particular release. Author + * probably wants assistance testing it. + * bitrotten - driver has not been update in a long time, probably + * doesn't work, and probably is missing support for significant + * Comedi interface features. + * untested - author probably wrote it "blind", and is believed to + * work, but no confirmation. + */ + #include #include #include -- 2.26.2