Changeset 58144 in vbox for trunk/src/VBox/Additions/common

Timestamp:

Oct 9, 2015 12:44:44 PM (9 years ago)

Author:

vboxsync

Message:

*: Doxygen fixes.

File:

• trunk/src/VBox/Additions/common/VBoxControl/VBoxControl.cpp (modified) (1 diff)

trunk/src/VBox/Additions/common/VBoxControl/VBoxControl.cpp

@@ -54 +54 @@
 
 
-/**
- * Displays the program usage message.
+/** @name Displays the program usage message.
+ * @{
+ */
+
+/**
+ * Helper function that does indentation.
  *
- * @param u64Which
- *
- * @{
- */
-
-/** Helper function */
-static void doUsage(char const *line, char const *name = "", char const *command = "")
+ * @param   pszLine     Text.
+ * @param   pszName     Program name.
+ * @param   pszCommand  Command/option syntax.
+ */
+static void doUsage(char const *pszLine, char const *pszName = "", char const *pszCommand = "")
 {
     /* Allow for up to 15 characters command name length (VBoxControl.exe) with
      * perfect column alignment. Beyond that there's at least one space between
      * the command if there are command line parameters. */
-    RTPrintf("%s %-*s%s%s\n", name, strlen(line) ? 35 - strlen(name) : 1,
-                              command, strlen(line) ? " " : "", line);
+    RTPrintf("%s %-*s%s%s\n",
+             pszName,
+             *pszLine ? 35 - strlen(name) : 1, pszCommand,
+             *pszLine ? " " : "", pszLine);
 }