HOTFIX IC-2021-01-12, Fix osal and usersguide doxygen warning

Added Doxygen escape character "\" to "<>" symbols in comments
nasa · Jan 13, 2021 · f9dd6b3 · f9dd6b3
1 parent b30e58d
commit f9dd6b3
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/os/inc/osapi-filesys.h b/src/os/inc/osapi-filesys.h
@@ -70,8 +70,8 @@ typedef struct
  * at runtime.  It is intended to be called by the PSP/BSP prior to starting the application.
  *
  * @note OSAL virtual mount points are required to be a single, non-empty top-level directory
- * name.  Virtual path names always follow the form /<virt_mount_point>/<relative_path>/<file>.
- * Only the relative path may be omitted/empty (i.e. /<virt_mount_point>/<file>) but the
+ * name.  Virtual path names always follow the form /\<virt_mount_point\>/\<relative_path\>/\<file\>.
+ * Only the relative path may be omitted/empty (i.e. /\<virt_mount_point\>/\<file\>) but the
  * virtual mount point must be present and not an empty string.  In particular this means
  * it is not possible to directly refer to files in the "root" of the native file system
  * from OSAL.  However it is possible to create a virtual map to the root, such as by calling: