iprt

Timestamp:

May 11, 2023 1:01:08 AM (22 months ago)

Author:

vboxsync

Message:

*: doxygen corrections (mostly about removing @returns from functions returning void).

Location:

trunk/include/iprt

Files:

trunk/include/iprt/armv8.h

r99736	r99739
160	160	\| ARMV8_AARCH64_SYSREG_CRN_MASK \| ARMV8_AARCH64_SYSREG_CRN_MASK \
161	161	\| ARMV8_AARCH64_SYSREG_OP2_MASK)
	162	/** @} */
162	163
163	164	/** @name Mapping of op0:op1:CRn:CRm:op2 to a system register ID. This is

-              r98103
+              r99739
  * Writes a machine specific register.
+ *
- * @returns Register content.
  * @param   uRegister   Register to write to.
  * @param   u64Val      Value to write.
 …
  * Writes a machine specific register, extended version (for AMD).
+ *
- * @returns Register content.
  * @param   uRegister   Register to write to.
  * @param   uXDI        RDI/EDI value.

-              r99563
+              r99739
  * Atomically writes a size_t value, ordered.
+ *
- * @returns nothing.
  * @param   pcb     Pointer to the size_t variable to write.
  * @param   cb      The value to assign to *pcb.
 …
  * Atomically writes a size_t value, unordered.
+ *
- * @returns nothing.
  * @param   pcb     Pointer to the size_t variable to write.
  * @param   cb      The value to assign to *pcb.

r98103	r99739
532	532	/**
533	533	* Called after status, headers and body all have been presented.
534		*
535		* @returns IPRT status code.
536	534	*/
537	535	virtual void receiveFinal() RT_NOEXCEPT;

r98103	r99739
390	390	* This overwrites any other callback set previously.
391	391	*
392		* @returns nothing.
393	392	* @param hVol The volume handle.
394	393	* @param pfnQueryBlockStatus The callback to set. Can be NULL to disable

r98103	r99739
140	140	* associated resources.
141	141	*
142		* @returns nothing.
143	142	* @param hIoQueueProv The I/O queue provider instance to destroy.
144	143	*/

r98103	r99739
529	529	* associated with it (@a pvUser).
530	530	*
531		* @returns IPRT status code
532	531	* @param pvUser The user parameter.
533	532	* @param cbImage The image size.

r98103	r99739
485	485	* List concatenation.
486	486	*
487		* @returns nothing.
488	487	* @param pListDst The destination list.
489	488	* @param pListSrc The source list to concatenate.

r98103	r99739
533	533	* List concatenation.
534	534	*
535		* @returns nothing.
536	535	* @param pListDst The destination list.
537	536	* @param pListSrc The source list to concatenate.

r98103	r99739
245	245	* RTMemWipeThorougly.
246	246	*
247		* @returns Pointer to the allocated memory.
248	247	* @param pv The allocation.
249	248	* @param cb The allocation size.

-              r98103
+              r99739
  * Initialize a S/G buffer structure.
+ *
- * @returns nothing.
  * @param   pSgBuf    Pointer to the S/G buffer to initialize.
  * @param   paSegs    Pointer to the start of the segment array.
 …
  * Resets the internal buffer position of the S/G buffer to the beginning.
+ *
- * @returns nothing.
  * @param   pSgBuf    The S/G buffer to reset.
  */
 …
  * Clones a given S/G buffer.
+ *
- * @returns nothing.
  * @param   pSgBufNew    The new S/G buffer to clone to.
  * @param   pSgBufOld    The source S/G buffer to clone from.

r98103	r99739
324	324	* Free string allocated by any of the non-UCS-2 string functions.
325	325	*
326		* @returns iprt status code.
327	326	* @param pszString Pointer to buffer with string to free.
328	327	* NULL is accepted.

r98103	r99739
688	688	* spinlocks are fine though.
689	689	*
690		* @returns IPRT status code.
691	690	* @param enmEvent The thread-context event. Please quitely ignore unknown
692	691	* events, we may add more (thread exit, ++) later.

r98103	r99739
347	347	* Gives the time in seconds and nanoseconds.
348	348	*
349		* @returns pTime.
350	349	* @param pTime The time spec to interpret.
351	350	* @param *pi32Seconds Where to store the time period in seconds.

-              r98103
+              r99739
  * Frees all resources of the given array of event headers as allocated by RTTraceLogRdrEvtMapToStruct().
+ *
- * @returns nothing.
  * @param   paEvtHdr            Pointer to the array of events as returned by RTTraceLogRdrEvtMapToStruct().
  * @param   cEvts               Number of events as returned by RTTraceLogRdrEvtMapToStruct().
 …
  * Frees a previously created iterator.
+ *
- * @returns nothing.
  * @param   hIt                 The iterator handle to free.
  */

r98103	r99739
172	172	* RTLatin1ToUtf16(), RTLatin1ToUtf16Ex(), RTUtf16Dup() or RTUtf16DupEx().
173	173	*
174		* @returns iprt status code.
175	174	* @param pwszString The UTF-16 string to free. NULL is accepted.
176	175	*/

Note: See TracChangeset for help on using the changeset viewer.