[PATCH 2/9] trivial: relocate doxygen help page for led command
Mark Vels
mark.vels at team-embedded.nl
Tue Nov 1 06:09:38 EDT 2011
Signed-off-by: Mark Vels <mark.vels at team-embedded.nl>
---
Documentation/commands.dox | 1 +
commands/led.c | 16 +++++++++-------
2 files changed, 10 insertions(+), 7 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 2b5bc44..31183ec 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -58,6 +58,7 @@ available in @a Barebox:
@li @subpage icache
@li @subpage iminfo
@li @subpage insmod
+ at li @subpage led_command
@li @subpage linux16_command
@li @subpage loadenv_command
@li @subpage loadb
diff --git a/commands/led.c b/commands/led.c
index 7fd9d44..2591ed0 100644
--- a/commands/led.c
+++ b/commands/led.c
@@ -74,21 +74,23 @@ static int do_led(struct command *cmdtp, int argc, char *argv[])
return 0;
}
+
+BAREBOX_CMD_HELP_START(led)
+BAREBOX_CMD_HELP_USAGE("led <led> <value>\n")
+BAREBOX_CMD_HELP_SHORT("control the value of a LED. a value of 0 means disabled\n")
+BAREBOX_CMD_HELP_SHORT("without arguments the available LEDs are listed\n")
+BAREBOX_CMD_HELP_END
+
/**
* @page led_command
-The exact meaning of <value> is unspecified. It can be a color in case of rgb
+The exact meaning of <value> is unspecified. It can be a color in case of rgb
LEDs or a brightness if this is controllable. In most cases only 1 for enabled
is allowed.
+\note This command is available only if enabled in menuconfig.
*/
-BAREBOX_CMD_HELP_START(led)
-BAREBOX_CMD_HELP_USAGE("led <led> <value>\n")
-BAREBOX_CMD_HELP_SHORT("control the value of a LED. a value of 0 means disabled\n")
-BAREBOX_CMD_HELP_SHORT("without arguments the available LEDs are listed\n")
-BAREBOX_CMD_HELP_END
-
BAREBOX_CMD_START(led)
.cmd = do_led,
.usage = "led <led> <value>",
--
1.7.0.4
More information about the barebox
mailing list