Skip to content

Commit

Permalink
Fix nasa#1130, Clean trailing whitespace: Doxygen
Browse files Browse the repository at this point in the history
Removes trailing whitespace in:
- *.dox
- *doxyfile.in
  • Loading branch information
astrogeco committed Mar 16, 2021
1 parent d554b5e commit db0b9bb
Show file tree
Hide file tree
Showing 14 changed files with 793 additions and 793 deletions.
4 changes: 2 additions & 2 deletions cmake/cfe-common.doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ PAPER_TYPE = letter
#---------------------------------------------------------------------------
COMPACT_RTF = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
HAVE_DOT = YES
Expand All @@ -102,7 +102,7 @@ CALL_GRAPH = YES
GRAPHICAL_HIERARCHY = NO
MAX_DOT_GRAPH_DEPTH = 1000
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
#---------------------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions cmake/mission-detaildesign.doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ INPUT += @MISSION_DEFS@ \
@MISSION_SOURCE_DIR@/cfe/modules/sbr/fsw \
@MISSION_SOURCE_DIR@/cfe/modules/tbl/fsw \
@MISSION_SOURCE_DIR@/cfe/modules/time/fsw

STRIP_FROM_PATH += @MISSION_DEFS@

#---------------------------------------------------------------------------
# The user content doxyfile contains paths to the mission-specific applications
# The user content doxyfile contains paths to the mission-specific applications
#---------------------------------------------------------------------------
@INCLUDE = @CMAKE_BINARY_DIR@/doc/mission-content.doxyfile
12 changes: 6 additions & 6 deletions cmake/osal-common.doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ WARN_LOGFILE = @CMAKE_BINARY_DIR@/doc/warnings.log
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
STRIP_FROM_PATH = @MISSION_SOURCE_DIR@
STRIP_FROM_PATH = @MISSION_SOURCE_DIR@

# Always include a standard set of CFE documentation in the input set
# This is applicable to both users guide and detail design outputs
INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/cfs_versions.dox
INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/osal_fs.dox
INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/osal_timer.dox
INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/cfs_versions.dox
INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/osal_fs.dox
INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/osal_timer.dox

FILE_PATTERNS = *.c *.cpp *.cc *.C *.h *.hh *.hpp *.H *.dox *.md
RECURSIVE = YES
Expand All @@ -61,7 +61,7 @@ PAPER_TYPE = letter
#---------------------------------------------------------------------------
COMPACT_RTF = YES
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
HAVE_DOT = YES
Expand All @@ -73,6 +73,6 @@ CALL_GRAPH = YES
GRAPHICAL_HIERARCHY = NO
MAX_DOT_GRAPH_DEPTH = 1000
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
404 changes: 202 additions & 202 deletions docs/src/cfe_es.dox

Large diffs are not rendered by default.

312 changes: 156 additions & 156 deletions docs/src/cfe_evs.dox

Large diffs are not rendered by default.

54 changes: 27 additions & 27 deletions docs/src/cfe_glossary.dox
Original file line number Diff line number Diff line change
@@ -1,87 +1,87 @@
/**
\page cfeglossary Glossary of Terms

<TABLE>
<TR>
<TH> Term
<TH> Definition
<TR>
<TD> \anchor cfeadg_application Application (or App)
<TD> A set of data and functions that is treated as a single entity
by the cFE. cFE resources are allocated on a per-Application
basis. Applications are made up of a Main Task and zero or
<TD> A set of data and functions that is treated as a single entity
by the cFE. cFE resources are allocated on a per-Application
basis. Applications are made up of a Main Task and zero or
more Child Tasks.
<TR>
<TD> \anchor cfeadg_applicationid Application ID
<TD> A processor unique reference to an Application. <BR>
<B> NOTE: This is different from a CCSDS Application ID which is
<B> NOTE: This is different from a CCSDS Application ID which is
referred to as an "APID." </B>
<TR>
<TD> \anchor cfeadg_api Application Programmer's Interface (API)
<TD> A set of routines, protocols, and tools for building software
<TD> A set of routines, protocols, and tools for building software
applications
<TR>
<TD> \anchor cfeadg_psp Platform Support Package (PSP)
<TD> A collection of user-provided facilities that interface an OS
and the cFE with a specific hardware platform. The PSP is
<TD> A collection of user-provided facilities that interface an OS
and the cFE with a specific hardware platform. The PSP is
responsible for hardware initialization.
<TR>
<TD> \anchor cfeadg_childtask Child Task
<TD> A separate thread of execution that is spawned by an
<TD> A separate thread of execution that is spawned by an
Application's Main Task.
<TR>
<TD> \anchor cfeadg_command Command
<TD> A Software Bus Message defined by the receiving Application.
Commands can originate from other onboard Applications or
<TD> A Software Bus Message defined by the receiving Application.
Commands can originate from other onboard Applications or
from the ground.
<TR>
<TD> \anchor cfeadg_cfe Core Flight Executive (cFE)
<TD> A runtime environment and a set of services for hosting FSW
<TD> A runtime environment and a set of services for hosting FSW
Applications
<TR>
<TD> \anchor cfeadg_cds Critical Data Store (CDS)
<TD> A collection of data that is not modified by the OS or
<TD> A collection of data that is not modified by the OS or
cFE following a Processor Reset.
<TR>
<TD> \anchor cfeadg_crc Cyclic Redundancy Check
<TD> A polynomial based method for checking that a data set
<TD> A polynomial based method for checking that a data set
has remained unchanged from one time period to another.
<TR>
<TD> \anchor cfeadg_developer Developer
<TD> Anyone who is coding a cFE Application.
<TR>
<TD> \anchor cfeadg_eventdata Event Data
<TD> Data describing an Event that is supplied to the cFE
Event Service. The cFE includes this data in an
<TD> Data describing an Event that is supplied to the cFE
Event Service. The cFE includes this data in an
\ref cfeadg_eventmessage "Event Message".
<TR>
<TD> \anchor cfeadg_eventfilter Event Filter
<TD> A numeric value (bit mask) used to determine how
frequently to output an application Event Message
<TD> A numeric value (bit mask) used to determine how
frequently to output an application Event Message
defined by its \ref cfeadg_eventid "Event ID".
<TR>
<TD> \anchor cfeadg_eventformatmode Event Format Mode
<TD> Defines the Event Message Format downlink option: short or long.
<TD> Defines the Event Message Format downlink option: short or long.
The short format is used when there is limited telemetry bandwidth
and is binary. The long format is in ASCII and is used for
and is binary. The long format is in ASCII and is used for
logging to a Local Event Log and to an Event Message Port.
<TR>
<TD> \anchor cfeadg_eventid Event ID
<TD> A numeric literal used to uniquely name an Application event.
<TR>
<TD> \anchor cfeadg_eventtype Event Type
<TD> A numeric literal used to identify the type of an Application event.
An event type may be #CFE_EVS_EventType_DEBUG, #CFE_EVS_EventType_INFORMATION,
An event type may be #CFE_EVS_EventType_DEBUG, #CFE_EVS_EventType_INFORMATION,
#CFE_EVS_EventType_ERROR, or #CFE_EVS_EventType_CRITICAL.
<TR>
<TD> \anchor cfeadg_eventmessage Event Message
<TD> A data item used to notify the user and/or an external
\ref cfeadg_application "Application" of a significant event.
Event Messages include a time-stamp of when the message was
generated, a processor unique identifier, an
<TD> A data item used to notify the user and/or an external
\ref cfeadg_application "Application" of a significant event.
Event Messages include a time-stamp of when the message was
generated, a processor unique identifier, an
\ref cfeadg_applicationid "Application ID", the
\ref cfeadg_eventtype "Event Type" (DEBUG,INFO,ERROR or CRITICAL),
and \ref cfeadg_eventdata "Event Data". An Event Message can
\ref cfeadg_eventtype "Event Type" (DEBUG,INFO,ERROR or CRITICAL),
and \ref cfeadg_eventdata "Event Data". An Event Message can
either be real-time or playback from a Local Event Log.
</TABLE>
**/
4 changes: 2 additions & 2 deletions docs/src/cfe_sb.dox
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
from header implementation, often abbreviated as message ID, MsgId, or MID.
Header and message identifier values should not be accessed directly to
avoid implementation specific dependencies.

Telemetry packets typically contain a timestamp that indicates when the packet
was produced. Command packets typically contain a command code that identifies
the particular type of command.
Expand Down Expand Up @@ -506,7 +506,7 @@
How many copies of the message are performed in a typical message delivery?
</B><TR><TD WIDTH="5%"> &nbsp; <TD WIDTH="95%">
There is a single copy of the message performed when sending a message
(from the callers memory space) using CFE_SB_TransmitMsg.
(from the callers memory space) using CFE_SB_TransmitMsg.
When transmitting the message, the software bus copies the message from the
callers memory space into a buffer in the software bus memory space. There
is also the option to request a buffer from SB, write directly to the buffer
Expand Down
Loading

0 comments on commit db0b9bb

Please sign in to comment.