Skip to content

Commit 784fe09

Browse files
committed
Fix nasa#540, Scrub User's Guide and related comments
NOTE - Comments/documentation only, no logic updates Also fixes nasa#403, resolves all warnings Also fixes nasa#536, comment typo in CFE_SB_RcvMsg implementation header
1 parent 9325ce2 commit 784fe09

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+2902
-4094
lines changed

cmake/cfe-common.doxyfile.in

+3-10
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ CREATE_SUBDIRS = NO
77
OUTPUT_LANGUAGE = English
88
OUTPUT_DIRECTORY = .
99
BRIEF_MEMBER_DESC = YES
10-
REPEAT_BRIEF = NO
10+
REPEAT_BRIEF = YES
1111
ABBREVIATE_BRIEF = "The $name class " \
1212
"The $name widget " \
1313
"The $name file " \
@@ -30,13 +30,6 @@ INHERIT_DOCS = YES
3030
SEPARATE_MEMBER_PAGES = NO
3131
TAB_SIZE = 8
3232
ALIASES += "event=\xrefitem cfeevents \"Event Message\" \"cFE Event Message Cross Reference\" " \
33-
"retdesc=<TD WIDTH=\"80%\"> " \
34-
"retcode=<TR><TD WIDTH=\"20%\" VALIGN=TOP> " \
35-
endcode=</TR> \
36-
"returns=\return <TABLE BORDER=\"0\" CELLPADDING=\"2\" WIDTH=\"100%\"> " \
37-
endreturns=</TABLE> \
38-
"retstmt=<TR><TD COLSPAN=2 WIDTH=\"100%\"> " \
39-
endstmt=</TR> \
4033
"cfeescfg=\xrefitem cfeescfg \"Purpose\" \"cFE Executive Services Configuration Parameters\" " \
4134
"cfeevscfg=\xrefitem cfeevscfg \"Purpose\" \"cFE Event Services Configuration Parameters\" " \
4235
"cfetblcfg=\xrefitem cfetblcfg \"Purpose\" \"cFE Table Services Configuration Parameters\" " \
@@ -54,8 +47,8 @@ ALIASES += "event=\xrefitem cfeevents \"Event Message\" \"cFE Even
5447
"cfeevstlm=\xrefitem cfeevstlm \"Name\" \"cFE Event Services Telemetry\" " \
5548
"cfesbtlm=\xrefitem cfesbtlm \"Name\" \"cFE Software Bus Telemetry\" " \
5649
"cfetimetlm=\xrefitem cfetimetlm \"Name\" \"cFE Time Services Telemetry\" " \
57-
"cfecmdmnemonic=\xrefitem cfecmdmnems \"Command Mnemonic(s)\" \"cFE Command Mnemonic Cross Reference\" \b \c " \
58-
"cfetlmmnemonic=\xrefitem cfetlmmnems \"Telemetry Mnemonic(s)\" \"cFE Telemetry Mnemonic Cross Reference\" \b \c "
50+
"cfecmdmnemonic=\xrefitem cfecmdmnems \"Command Mnemonic(s)\" \"cFE Command Mnemonic Cross Reference\" " \
51+
"cfetlmmnemonic=\xrefitem cfetlmmnems \"Telemetry Mnemonic(s)\" \"cFE Telemetry Mnemonic Cross Reference\" "
5952
OPTIMIZE_OUTPUT_FOR_C = YES
6053
OPTIMIZE_OUTPUT_JAVA = NO
6154
BUILTIN_STL_SUPPORT = NO

cmake/osal-common.doxyfile.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ CREATE_SUBDIRS = NO
77
OUTPUT_LANGUAGE = English
88
OUTPUT_DIRECTORY = .
99
BRIEF_MEMBER_DESC = YES
10-
REPEAT_BRIEF = NO
10+
REPEAT_BRIEF = YES
1111
ABBREVIATE_BRIEF = "The $name class " \
1212
"The $name widget " \
1313
"The $name file " \

cmake/sample_defs/cpu1_platform_cfg.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,8 @@
126126
** Dictates the size of the SB memory pool. For each message the SB
127127
** sends, the SB dynamically allocates from this memory pool, the memory needed
128128
** to process the message. The memory needed to process each message is msg
129-
** size + msg descriptor(#CFE_SB_BufferD_t). This memory pool is also used
130-
** to allocate destination descriptors (#CFE_SB_DestinationD_t) during the
129+
** size + msg descriptor(CFE_SB_BufferD_t). This memory pool is also used
130+
** to allocate destination descriptors (CFE_SB_DestinationD_t) during the
131131
** subscription process.
132132
** To see the run-time, high-water mark and the current utilization figures
133133
** regarding this parameter, send an SB command to 'Send Statistics Pkt'.
@@ -788,7 +788,7 @@
788788
** log ER Log and critical reset variables. This is 4 of 4 of the memory areas
789789
** that are preserved during a processor reset.
790790
** Note: This area must be sized large enough to hold all of the data
791-
** structures. It should be automatically sized based on the #CFE_ES_ResetData_t
791+
** structures. It should be automatically sized based on the CFE_ES_ResetData_t
792792
** type, but circular dependancies in the headers prevent it from being defined
793793
** this way.
794794
** NOTE: Changing this value changes memory allocation, and may

docs/README_dox_templates.txt

-20
This file was deleted.

docs/dox_templates.xml

-95
This file was deleted.

0 commit comments

Comments
 (0)