Fix #364, Scrub user's guide

Document/comment changes only Partially addresses #255, #12, #18, #366
nasa · Mar 15, 2020 · a4abbfc · a4abbfc
1 parent 2284a6f
commit a4abbfc
Show file tree

Hide file tree

Showing 10 changed files with 981 additions and 699 deletions.
diff --git a/doc/OSAL Library API.doc b/doc/OSAL Library API.doc
diff --git a/doc/OSAL Library API.pdf b/doc/OSAL Library API.pdf
diff --git a/src/os/inc/common_types.h b/src/os/inc/common_types.h
@@ -97,7 +97,7 @@
  * Define the "osalbool" type for backward compatibility.
  * This will be removed in a future release.
  */
-typedef bool                                  osalbool;
+typedef bool                                  osalbool; /**< @deprecated Use bool */
 
 /*
  * Boolean type for compatibility --
@@ -116,15 +116,15 @@ typedef bool                                  osalbool;
  */
 
 #if (!defined(_USING_RTEMS_INCLUDES_) || !defined(RTEMS_DEPRECATED_TYPES))
-  typedef osalbool boolean;
+  typedef osalbool boolean; /**< @deprecated Use bool */
 #endif
 
 #ifndef TRUE              /* Boolean true */
-#define TRUE     true
+#define TRUE     true  /**< @deprecated Use true */
 #endif
 
 #ifndef FALSE              /* Boolean false */
-#define FALSE    false
+#define FALSE    false /**< @deprecated Use false */
 #endif