Changeset 57944 in vbox for trunk/src/VBox/Runtime/r3/solaris

Timestamp:

Sep 29, 2015 3:07:09 PM (10 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

102919

Message:

iprt: More doxygen corrections.

File:

• trunk/src/VBox/Runtime/r3/solaris/coredumper-solaris.cpp (modified) (11 diffs)

trunk/src/VBox/Runtime/r3/solaris/coredumper-solaris.cpp

@@ -399 +399 @@
  *
  * @param pSolCore          Pointer to the core object.
- * @param pszFileFmt        Only the name of the file to read from (/proc/<pid> will be prepended)
+ * @param pszProcFileName   Only the name of the file to read from
+ *                          (/proc/\<pid\> will be prepended)
  * @param ppv               Where to store the allocated buffer.
  * @param pcb               Where to store size of the buffer.
@@ -513 +514 @@
  * Read process credential information (format prcred_t + array of guid_t)
  *
+ * @return IPRT status code.
  * @param pSolCore          Pointer to the core object.
  *
  * @remarks Should not be called before successful call to @see AllocMemoryArea()
- * @return IPRT status code.
  */
 static int ProcReadCred(PRTSOLCORE pSolCore)
@@ -530 +531 @@
  * Read process privilege information (format prpriv_t + array of priv_chunk_t)
  *
+ * @return IPRT status code.
  * @param pSolCore          Pointer to the core object.
  *
  * @remarks Should not be called before successful call to @see AllocMemoryArea()
- * @return IPRT status code.
  */
 static int ProcReadPriv(PRTSOLCORE pSolCore)
@@ -556 +557 @@
  * Read process LDT information (format array of struct ssd) from /proc.
  *
- * @param pSolProc         Pointer to the core object.
+ * @return  IPRT status code.
+ * @param   pSolCore        Pointer to the core object.
  *
  * @remarks Should not be called before successful call to @see AllocMemoryArea()
- * @return IPRT status code.
  */
 static int ProcReadLdt(PRTSOLCORE pSolCore)
@@ -573 +574 @@
  * Read process auxiliary vectors (format auxv_t) for the process.
  *
+ * @return IPRT status code.
  * @param pSolCore          Pointer to the core object.
  *
  * @remarks Should not be called before successful call to @see AllocMemoryArea()
- * @return IPRT status code.
  */
 static int ProcReadAuxVecs(PRTSOLCORE pSolCore)
@@ -663 +664 @@
  * Read the process mappings (format prmap_t array).
  *
+ * @return IPRT status code.
  * @param   pSolCore            Pointer to the core object.
  *
  * @remarks Should not be called before successful call to @see AllocMemoryArea()
- * @return IPRT status code.
  */
 static int ProcReadMappings(PRTSOLCORE pSolCore)
@@ -801 +802 @@
  * Reads the thread information for all threads in the process.
  *
+ * @return IPRT status code.
  * @param pSolCore          Pointer to the core object.
  *
  * @remarks Should not be called before successful call to @see AllocMemoryArea()
- * @return IPRT status code.
  */
 static int ProcReadThreads(PRTSOLCORE pSolCore)
@@ -1843 +1844 @@
  * to be in suspended state (i.e. called after CreateCore).
  *
+ * @return IPRT status.
  * @param pSolCore          Pointer to the core object.
  * @param pfnWriter         Pointer to the writer function to override default writer (NULL uses default).
@@ -1848 +1850 @@
  * @remarks Resumes all suspended threads, unless it's an invalid core. This
  *          function must be called only -after- rtCoreDumperCreateCore().
- * @return IPRT status.
  */
 static int rtCoreDumperWriteCore(PRTSOLCORE pSolCore, PFNRTCOREWRITER pfnWriter)
@@ -1913 +1914 @@
  * are ultimately resumed en-masse) already suspended while calling this function.
  *
+ * @return IPRT status code.
  * @param pSolCore          Pointer to a core object.
  * @param pContext          Pointer to the caller context thread.
@@ -1919 +1921 @@
  *
  * @remarks Halts all threads.
- * @return IPRT status code.
  */
 static int rtCoreDumperCreateCore(PRTSOLCORE pSolCore, ucontext_t *pContext, const char *pszCoreFilePath)