mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Mark Vels <mark.vels@team-embedded.nl>
To: barebox@lists.infradead.org
Subject: [PATCH 2/9] trivial: relocate doxygen help page for led command
Date: Tue,  1 Nov 2011 11:09:38 +0100	[thread overview]
Message-ID: <20be88d72bbe97474097bf96b2999e7fd2c763c7.1320141619.git.mark.vels@team-embedded.nl> (raw)
In-Reply-To: <cover.1320141619.git.mark.vels@team-embedded.nl>
In-Reply-To: <cover.1320141619.git.mark.vels@team-embedded.nl>


Signed-off-by: Mark Vels <mark.vels@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
+@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 &lt;value&gt; 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


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

  parent reply	other threads:[~2011-11-01 10:09 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-01 10:09 [RFC PATCH 0/9] Catch-up/clean-up doxygen documentation Mark Vels
2011-11-01 10:09 ` [PATCH 1/9] trivial: relocate doxygen help page for time command Mark Vels
2011-11-01 10:09 ` Mark Vels [this message]
2011-11-01 10:09 ` [PATCH 3/9] trivial: reorganize crc32 command doxygen output Mark Vels
2011-11-01 10:09 ` [PATCH 4/9] trivial: fix doxygen error in dlink-dir-320.dox Mark Vels
2011-11-01 10:09 ` [PATCH 5/9] trivial: De-orphan NAND doxygen output and fix @param syntax Mark Vels
2011-11-01 10:09 ` [PATCH 6/9] docs: Enable BAREBOX_CMD_HELP_TEXT() in generated documentation Mark Vels
2011-11-01 10:09 ` [PATCH 7/9] doxygen: Enable LONGHELP output in generated output Mark Vels
2011-11-01 10:09 ` [PATCH 8/9] trivial: Small change in page link title Mark Vels
2011-11-01 10:09 ` [PATCH 9/9] help: update of shell commands doxygen/online help documentation Mark Vels
2011-11-03  7:26 ` [RFC PATCH 0/9] Catch-up/clean-up doxygen documentation Sascha Hauer
2011-11-03 12:48   ` Mark Vels
2011-11-04  9:06     ` Sascha Hauer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20be88d72bbe97474097bf96b2999e7fd2c763c7.1320141619.git.mark.vels@team-embedded.nl \
    --to=mark.vels@team-embedded.nl \
    --cc=barebox@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox