Changeset 68862 in vbox

Timestamp:

Sep 25, 2017 8:19:14 PM (7 years ago)

Author:

vboxsync

Message:

iprt,vboxmanage,manual: Try write the iso maker docs as a docbook refentry document. Tried to generalize the vboxmanage refentry output handling, moving it to RTMsg*. Made VBoxManage and IPRT generate their C/H sources in their own Makefiles. Hacked the C/H source generation till it can deal with the rather different RTIsoMaker command structure (no sub or sub-sub command stuff). [doxygen]

Location:

trunk

Files:

• include/iprt/message.h (modified) (2 diffs)
• src/VBox/Runtime/common/misc/messagerefentry.cpp (modified) (1 diff)

trunk/include/iprt/message.h

@@ -288 +288 @@
 typedef struct RTSTREAM *PRTSTREAM;
 
+
+/**
+ * Print the synopsis to the given stream.
+ *
+ * @returns Current number of pending blank lines.
+ * @param   pStrm               The output stream.
+ * @param   pEntry              The refentry to print the help for.
+ */
+RTDECL(int) RTMsgRefEntrySynopsis(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry);
+
+
+/**
+ * Print the synopsis to the given stream.
+ *
+ * @returns Current number of pending blank lines.
+ * @param   pStrm               The output stream.
+ * @param   pEntry              The refentry to print the help for.
+ * @param   fScope              The scope inclusion mask.
+ * @param   fFlags              RTMSGREFENTRY_SYNOPSIS_F_XXX.
+ */
 RTDECL(int) RTMsgRefEntrySynopsisEx(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry, uint64_t fScope, uint32_t fFlags);
 /** @name  RTMSGREFENTRY_SYNOPSIS_F_XXX -  Flags for RTMsgRefEntrySynopsisEx.
@@ -295 +315 @@
 /** @}  */
 
-RTDECL(int) RTMsgRefEntrySynopsis(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry);
-
+
+/**
+ * Print the help text to the given stream.
+ *
+ * @returns Current number of pending blank lines.
+ * @param   pStrm               The output stream.
+ * @param   pEntry              The refentry to print the help for.
+ */
+RTDECL(int) RTMsgRefEntryHelp(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry);
+
+/**
+ * Print the help text to the given stream, extended version.
+ *
+ * @returns Current number of pending blank lines.
+ * @param   pStrm               The output stream.
+ * @param   pEntry              The refentry to print the help for.
+ * @param   fScope              The scope inclusion mask.
+ * @param   fFlags              Reserved, MBZ.
+ */
 RTDECL(int) RTMsgRefEntryHelpEx(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry, uint64_t fScope, uint32_t fFlags);
-RTDECL(int) RTMsgRefEntryHelp(PRTSTREAM pStrm, PCRTMSGREFENTRY pEntry);
+
+/**
+ * Prints a string table.
+ *
+ * @returns Current number of pending blank lines.
+ * @param   pStrm               The output stream.
+ * @param   pStrTab             The string table.
+ * @param   fScope              The selection scope.
+ * @param   pcPendingBlankLines In: Pending blank lines from previous string
+ *                              table.  Out: Pending blank lines.
+ * @param   pcLinesWritten      Pointer to variable that should be incremented
+ *                              by the number of lines written.  Optional.
+ */
 RTDECL(int) RTMsgRefEntryPrintStringTable(PRTSTREAM pStrm, PCRTMSGREFENTRYSTRTAB pStrTab, uint64_t fScope,
                                           uint32_t *pcPendingBlankLines, uint32_t *pcLinesWritten);

trunk/src/VBox/Runtime/common/misc/messagerefentry.cpp

@@ -234 +234 @@
  * @param   pStrTab             The string table.
  * @param   fScope              The selection scope.
- * @param   cPendingBlankLines  Pending blank lines from previous string table.
+ * @param   pcPendingBlankLines In: Pending blank lines from previous string
+ *                              table.  Out: Pending blank lines.
  * @param   pcLinesWritten      Pointer to variable that should be incremented
  *                              by the number of lines written.  Optional.