[rtems commit] Fix a number of minor Doxygen formatting issues
Joel Sherril
joel at rtems.org
Fri Mar 6 16:39:40 UTC 2015
Module: rtems
Branch: master
Commit: cc69334f420fc3d41509a176635f3cca6112821d
Changeset: http://git.rtems.org/rtems/commit/?id=cc69334f420fc3d41509a176635f3cca6112821d
Author: Joel Sherrill <joel.sherrill at oarcorp.com>
Date: Fri Mar 6 10:35:40 2015 -0600
Fix a number of minor Doxygen formatting issues
---
c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h | 2 +-
cpukit/libfs/src/dosfs/dosfs.h | 10 +++++-----
cpukit/libmisc/capture/capture.h | 1 +
cpukit/libmisc/capture/captureimpl.h | 3 ++-
cpukit/rtems/include/rtems/rtems/semimpl.h | 4 ++--
cpukit/rtems/mainpage.h | 6 +++---
cpukit/score/include/rtems/score/threaddispatch.h | 2 +-
cpukit/score/include/rtems/score/threadimpl.h | 6 +++---
8 files changed, 18 insertions(+), 16 deletions(-)
diff --git a/c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h b/c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h
index db5b1d5..2aa8312 100644
--- a/c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h
+++ b/c/src/lib/libbsp/arm/lpc32xx/include/nand-mlc.h
@@ -396,7 +396,7 @@ rtems_status_code lpc32xx_mlc_read_blocks(
* @brief Checks if the page spare area indicates to a bad page.
*
* If the first (byte offset 0) or sixth (byte offset 5) byte of the spare area
- * has a value other than 0xff, then it returns @true (the page is bad), else
+ * has a value other than 0xff, then it returns @a true (the page is bad), else
* it returns @a false (the page is not bad).
*
* Samsung uses the sixth byte to indicate a bad page. Mircon uses the first
diff --git a/cpukit/libfs/src/dosfs/dosfs.h b/cpukit/libfs/src/dosfs/dosfs.h
index 481279e..7691ed7 100644
--- a/cpukit/libfs/src/dosfs/dosfs.h
+++ b/cpukit/libfs/src/dosfs/dosfs.h
@@ -35,7 +35,7 @@ typedef struct rtems_dosfs_convert_control rtems_dosfs_convert_control;
*
* @param[in,out] self The convert control.
* @param[in] src A well-formed UTF-8 string to be converted.
- * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
+ * @param[in] src_size The size of the string in bytes (inludes '\\0' if any).
* @param[out] dst The address the converted string will get copied to.
* @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer.
@@ -57,7 +57,7 @@ typedef int (*rtems_dosfs_utf8_to_codepage)(
*
* @param[in,out] self The convert control.
* @param[in] src A well-formed string in code page format.
- * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
+ * @param[in] src_size The size of the string in bytes (inludes '\\0' if any).
* @param[out] dst The address the converted string will get copied to.
* @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer.
@@ -79,7 +79,7 @@ typedef int (*rtems_dosfs_codepage_to_utf8)(
*
* @param[in,out] self The convert control.
* @param[in] src A well-formed UTF-8 string to be converted.
- * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
+ * @param[in] src_size The size of the string in bytes (inludes '\\0' if any).
* @param[out] dst The address the converted string will get copied to
* @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer.
@@ -101,7 +101,7 @@ typedef int (*rtems_dosfs_utf8_to_utf16)(
*
* @param[in,out] self The convert control.
* @param[in] src A well-formed UTF-16 string to be converted.
- * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
+ * @param[in] src_size The size of the string in bytes (inludes '\\0' if any).
* @param[out] dst The address the converted string will get copied to.
* @param[in,out] dst_size The size of the buffer in bytes respectively the
* number of bytes written to the buffer
@@ -126,7 +126,7 @@ typedef int (*rtems_dosfs_utf16_to_utf8)(
*
* @param[in,out] self The convert control.
* @param[in] src A well-formed UTF-8 string to be normalized and fold.
- * @param[in] src_size The size of the string in bytes (inludes '\0' if any).
+ * @param[in] src_size The size of the string in bytes (inludes '\\0' if any).
* @param[out] dst The address the normalized and fold string will get
* copied to.
* @param[in,out] dst_size The size of the buffer in bytes respectively the
diff --git a/cpukit/libmisc/capture/capture.h b/cpukit/libmisc/capture/capture.h
index 63d1343..99c8540 100644
--- a/cpukit/libmisc/capture/capture.h
+++ b/cpukit/libmisc/capture/capture.h
@@ -983,5 +983,6 @@ rtems_capture_control_count (void)
#ifdef __cplusplus
}
#endif
+/**@}*/
#endif
diff --git a/cpukit/libmisc/capture/captureimpl.h b/cpukit/libmisc/capture/captureimpl.h
index 77a6f07..549735e 100644
--- a/cpukit/libmisc/capture/captureimpl.h
+++ b/cpukit/libmisc/capture/captureimpl.h
@@ -220,7 +220,7 @@ static inline void *rtems_capture_append_to_record(void* rec,
} while (0)
/**
- * @brief .
+ * @brief Capture returns the current time.
*
* This function returns the current time. If a handler is provided
* by the user the time is gotten from that.
@@ -328,5 +328,6 @@ void rtems_capture_print_watch_list( void );
#ifdef __cplusplus
}
#endif
+/**@}*/
#endif
diff --git a/cpukit/rtems/include/rtems/rtems/semimpl.h b/cpukit/rtems/include/rtems/rtems/semimpl.h
index e0a35a2..b4d1e83 100644
--- a/cpukit/rtems/include/rtems/rtems/semimpl.h
+++ b/cpukit/rtems/include/rtems/rtems/semimpl.h
@@ -66,7 +66,7 @@ void _Semaphore_Manager_initialization(void);
* This function returns a RTEMS status code based on the mutex
* status code specified.
*
- * @param[in] the_mutex_status is the mutex status code to translate
+ * @param[in] status is the mutex status code to translate
*
* @retval translated RTEMS status code
*/
@@ -107,7 +107,7 @@ _Semaphore_Translate_MRSP_status_code( MRSP_Status mrsp_status )
* This function returns a RTEMS status code based on the semaphore
* status code specified.
*
- * @param[in] the_mutex_status is the semaphore status code to translate
+ * @param[in] status is the semaphore status code to translate
*
* @retval translated RTEMS status code
*/
diff --git a/cpukit/rtems/mainpage.h b/cpukit/rtems/mainpage.h
index 7206981..819e049 100644
--- a/cpukit/rtems/mainpage.h
+++ b/cpukit/rtems/mainpage.h
@@ -887,9 +887,9 @@
* A critical point with per-task variables is that each task must separately
* request that the same global variable is per-task private.
*
- * @b{WARNING}: Per-task variables are fundamentally incorrect in SMP
- * systems and should not be used in SMP applications. They
- * are disabled.
+ * @b {WARNING}: Per-task variables are fundamentally incorrect in SMP
+ * systems and should not be used in SMP applications. They
+ * are disabled.
*
* @section ClassicTasksSecBuildingTaskAttributeSet Building a Task Attribute Set
*
diff --git a/cpukit/score/include/rtems/score/threaddispatch.h b/cpukit/score/include/rtems/score/threaddispatch.h
index 037cf27..f8c3611 100644
--- a/cpukit/score/include/rtems/score/threaddispatch.h
+++ b/cpukit/score/include/rtems/score/threaddispatch.h
@@ -67,7 +67,7 @@ RTEMS_INLINE_ROUTINE bool _Thread_Dispatch_is_enabled(void)
}
/**
- * @briefs Gets thread dispatch disable level.
+ * @brief Gets thread dispatch disable level.
*
* @return The value of the thread dispatch level.
*/
diff --git a/cpukit/score/include/rtems/score/threadimpl.h b/cpukit/score/include/rtems/score/threadimpl.h
index 84c22f9..c4e7207 100644
--- a/cpukit/score/include/rtems/score/threadimpl.h
+++ b/cpukit/score/include/rtems/score/threadimpl.h
@@ -497,8 +497,8 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_executing (
#if defined(RTEMS_SMP)
/**
- * @brief Returns @true in case the thread executes currently on some processor
- * in the system, otherwise @a false.
+ * @brief Returns @a true in case the thread executes currently on some
+ * processor in the system, otherwise @a false.
*
* Do not confuse this with _Thread_Is_executing() which checks only the
* current processor.
@@ -512,7 +512,7 @@ RTEMS_INLINE_ROUTINE bool _Thread_Is_executing_on_a_processor(
#endif
/**
- * @brief Returns @true and sets time_of_context_switch to the the
+ * @brief Returns @a true and sets time_of_context_switch to the
* time of the last context switch when the thread is currently executing
* in the system, otherwise @a false.
*/
More information about the vc
mailing list