-
Notifications
You must be signed in to change notification settings - Fork 202
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
41 changed files
with
536 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
dist: bionic | ||
sudo: required | ||
language: | ||
- c | ||
compiler: | ||
- gcc | ||
addons: | ||
apt: | ||
sources: | ||
- ubuntu-toolchain-r-test | ||
packages: | ||
- cmake | ||
|
||
before_install: | ||
- sudo apt-get install cppcheck | ||
|
||
script: | ||
# Check versions | ||
- cppcheck --version | ||
|
||
#cppcheck flight software cfe/fsw/cfe-core/src | ||
- cppcheck --force --inline-suppr --std=c99 --language=c --error-exitcode=1 --enable=warning,performance,portability,style --suppress=variableScope --inconclusive fsw/cfe-core/src 2>cppcheck_flight_cfe.txt | ||
- | | ||
if [[ -s cppcheck_flight_cfe.txt ]]; then | ||
echo "You must fix cppcheck errors before submitting a pull request" | ||
echo "" | ||
cat cppcheck_flight_cfe.txt | ||
exit -1 | ||
fi | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,248 @@ | ||
#--------------------------------------------------------------------------- | ||
# Project related configuration options, shared for all cFE doxygen outputs | ||
#--------------------------------------------------------------------------- | ||
@INCLUDE_PATH = @MISSION_SOURCE_DIR@ | ||
DOXYFILE_ENCODING = UTF-8 | ||
CREATE_SUBDIRS = NO | ||
OUTPUT_LANGUAGE = English | ||
OUTPUT_DIRECTORY = . | ||
BRIEF_MEMBER_DESC = YES | ||
REPEAT_BRIEF = NO | ||
ABBREVIATE_BRIEF = "The $name class " \ | ||
"The $name widget " \ | ||
"The $name file " \ | ||
is \ | ||
provides \ | ||
specifies \ | ||
contains \ | ||
represents \ | ||
a \ | ||
an \ | ||
the | ||
ALWAYS_DETAILED_SEC = NO | ||
INLINE_INHERITED_MEMB = NO | ||
FULL_PATH_NAMES = YES | ||
SHORT_NAMES = NO | ||
JAVADOC_AUTOBRIEF = NO | ||
QT_AUTOBRIEF = NO | ||
MULTILINE_CPP_IS_BRIEF = NO | ||
DETAILS_AT_TOP = NO | ||
INHERIT_DOCS = YES | ||
SEPARATE_MEMBER_PAGES = NO | ||
TAB_SIZE = 8 | ||
OPTIMIZE_OUTPUT_FOR_C = YES | ||
OPTIMIZE_OUTPUT_JAVA = NO | ||
BUILTIN_STL_SUPPORT = NO | ||
CPP_CLI_SUPPORT = NO | ||
SIP_SUPPORT = NO | ||
DISTRIBUTE_GROUP_DOC = NO | ||
SUBGROUPING = YES | ||
TYPEDEF_HIDES_STRUCT = NO | ||
#--------------------------------------------------------------------------- | ||
# Build related configuration options | ||
#--------------------------------------------------------------------------- | ||
EXTRACT_ALL = YES | ||
EXTRACT_PRIVATE = YES | ||
EXTRACT_STATIC = YES | ||
EXTRACT_LOCAL_CLASSES = YES | ||
EXTRACT_LOCAL_METHODS = NO | ||
EXTRACT_ANON_NSPACES = NO | ||
HIDE_UNDOC_MEMBERS = NO | ||
HIDE_UNDOC_CLASSES = NO | ||
HIDE_FRIEND_COMPOUNDS = NO | ||
HIDE_IN_BODY_DOCS = NO | ||
INTERNAL_DOCS = NO | ||
CASE_SENSE_NAMES = NO | ||
HIDE_SCOPE_NAMES = NO | ||
SHOW_INCLUDE_FILES = YES | ||
INLINE_INFO = YES | ||
SORT_MEMBER_DOCS = YES | ||
SORT_BRIEF_DOCS = NO | ||
SORT_BY_SCOPE_NAME = NO | ||
GENERATE_TODOLIST = NO | ||
GENERATE_TESTLIST = YES | ||
GENERATE_BUGLIST = YES | ||
GENERATE_DEPRECATEDLIST= YES | ||
ENABLED_SECTIONS = | ||
MAX_INITIALIZER_LINES = 30 | ||
SHOW_USED_FILES = YES | ||
SHOW_DIRECTORIES = YES | ||
FILE_VERSION_FILTER = | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to warning and progress messages | ||
#--------------------------------------------------------------------------- | ||
QUIET = NO | ||
WARNINGS = YES | ||
WARN_IF_UNDOCUMENTED = YES | ||
WARN_IF_DOC_ERROR = YES | ||
WARN_NO_PARAMDOC = YES | ||
WARN_FORMAT = "$file:$line: $text " | ||
WARN_LOGFILE = @CMAKE_BINARY_DIR@/doc/warnings.log | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to the input files | ||
#--------------------------------------------------------------------------- | ||
INPUT_ENCODING = UTF-8 | ||
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 | ||
#IMAGE_PATH += | ||
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 | ||
EXCLUDE = | ||
EXCLUDE_SYMLINKS = NO | ||
EXCLUDE_PATTERNS = | ||
EXCLUDE_SYMBOLS = | ||
EXAMPLE_PATH = | ||
EXAMPLE_PATTERNS = * | ||
EXAMPLE_RECURSIVE = NO | ||
INPUT_FILTER = | ||
FILTER_PATTERNS = | ||
FILTER_SOURCE_FILES = NO | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to source browsing | ||
#--------------------------------------------------------------------------- | ||
SOURCE_BROWSER = YES | ||
INLINE_SOURCES = NO | ||
STRIP_CODE_COMMENTS = YES | ||
REFERENCED_BY_RELATION = YES | ||
REFERENCES_RELATION = YES | ||
REFERENCES_LINK_SOURCE = YES | ||
USE_HTAGS = NO | ||
VERBATIM_HEADERS = YES | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to the alphabetical class index | ||
#--------------------------------------------------------------------------- | ||
ALPHABETICAL_INDEX = YES | ||
COLS_IN_ALPHA_INDEX = 5 | ||
IGNORE_PREFIX = | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to the HTML output | ||
#--------------------------------------------------------------------------- | ||
GENERATE_HTML = YES | ||
HTML_OUTPUT = html | ||
HTML_FILE_EXTENSION = .html | ||
HTML_HEADER = | ||
HTML_FOOTER = | ||
HTML_STYLESHEET = | ||
HTML_ALIGN_MEMBERS = YES | ||
GENERATE_HTMLHELP = NO | ||
HTML_DYNAMIC_SECTIONS = NO | ||
CHM_FILE = | ||
HHC_LOCATION = | ||
GENERATE_CHI = NO | ||
BINARY_TOC = NO | ||
TOC_EXPAND = NO | ||
DISABLE_INDEX = NO | ||
ENUM_VALUES_PER_LINE = 4 | ||
GENERATE_TREEVIEW = NO | ||
TREEVIEW_WIDTH = 250 | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to the LaTeX output | ||
#--------------------------------------------------------------------------- | ||
GENERATE_LATEX = NO | ||
LATEX_OUTPUT = latex | ||
LATEX_CMD_NAME = latex | ||
MAKEINDEX_CMD_NAME = makeindex | ||
COMPACT_LATEX = YES | ||
PAPER_TYPE = letter | ||
EXTRA_PACKAGES = | ||
LATEX_HEADER = | ||
PDF_HYPERLINKS = YES | ||
USE_PDFLATEX = YES | ||
LATEX_BATCHMODE = NO | ||
LATEX_HIDE_INDICES = NO | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to the RTF output | ||
#--------------------------------------------------------------------------- | ||
GENERATE_RTF = NO | ||
RTF_OUTPUT = rtf | ||
COMPACT_RTF = YES | ||
RTF_HYPERLINKS = NO | ||
RTF_STYLESHEET_FILE = | ||
RTF_EXTENSIONS_FILE = | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to the man page output | ||
#--------------------------------------------------------------------------- | ||
GENERATE_MAN = NO | ||
MAN_OUTPUT = man | ||
MAN_EXTENSION = .3 | ||
MAN_LINKS = NO | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to the XML output | ||
#--------------------------------------------------------------------------- | ||
GENERATE_XML = NO | ||
XML_OUTPUT = xml | ||
XML_SCHEMA = | ||
XML_DTD = | ||
XML_PROGRAMLISTING = YES | ||
#--------------------------------------------------------------------------- | ||
# configuration options for the AutoGen Definitions output | ||
#--------------------------------------------------------------------------- | ||
GENERATE_AUTOGEN_DEF = NO | ||
#--------------------------------------------------------------------------- | ||
# configuration options related to the Perl module output | ||
#--------------------------------------------------------------------------- | ||
GENERATE_PERLMOD = NO | ||
PERLMOD_LATEX = NO | ||
PERLMOD_PRETTY = YES | ||
PERLMOD_MAKEVAR_PREFIX = | ||
#--------------------------------------------------------------------------- | ||
# Configuration options related to the preprocessor | ||
#--------------------------------------------------------------------------- | ||
ENABLE_PREPROCESSING = YES | ||
MACRO_EXPANSION = NO | ||
EXPAND_ONLY_PREDEF = NO | ||
SEARCH_INCLUDES = YES | ||
INCLUDE_PATH = | ||
INCLUDE_FILE_PATTERNS = | ||
EXPAND_AS_DEFINED = | ||
SKIP_FUNCTION_MACROS = YES | ||
#--------------------------------------------------------------------------- | ||
# Configuration::additions related to external references | ||
#--------------------------------------------------------------------------- | ||
TAGFILES = | ||
GENERATE_TAGFILE = | ||
ALLEXTERNALS = NO | ||
EXTERNAL_GROUPS = YES | ||
PERL_PATH = /usr/bin/perl | ||
#--------------------------------------------------------------------------- | ||
# Configuration options related to the dot tool | ||
#--------------------------------------------------------------------------- | ||
CLASS_DIAGRAMS = NO | ||
MSCGEN_PATH = | ||
HIDE_UNDOC_RELATIONS = YES | ||
HAVE_DOT = YES | ||
CLASS_GRAPH = NO | ||
COLLABORATION_GRAPH = NO | ||
GROUP_GRAPHS = YES | ||
UML_LOOK = NO | ||
TEMPLATE_RELATIONS = NO | ||
INCLUDE_GRAPH = NO | ||
INCLUDED_BY_GRAPH = NO | ||
CALL_GRAPH = YES | ||
CALLER_GRAPH = NO | ||
GRAPHICAL_HIERARCHY = NO | ||
DIRECTORY_GRAPH = YES | ||
DOT_IMAGE_FORMAT = png | ||
DOT_PATH = | ||
DOTFILE_DIRS = | ||
DOT_GRAPH_MAX_NODES = 50 | ||
MAX_DOT_GRAPH_DEPTH = 1000 | ||
DOT_TRANSPARENT = NO | ||
DOT_MULTI_TARGETS = NO | ||
GENERATE_LEGEND = YES | ||
DOT_CLEANUP = YES | ||
#--------------------------------------------------------------------------- | ||
# Configuration::additions related to the search engine | ||
#--------------------------------------------------------------------------- | ||
SEARCHENGINE = NO | ||
|
||
#--------------------------------------------------------------------------- | ||
# OSAL mnemonic mappings | ||
#--------------------------------------------------------------------------- | ||
#@INCLUDE = | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
#--------------------------------------------------------------------------- | ||
# Doxygen Configuration options to generate the "OSAL API Guide" | ||
#--------------------------------------------------------------------------- | ||
|
||
# Start with the common definitions, some of which are extended or overridden here. | ||
|
||
@INCLUDE = @MISSION_BINARY_DIR@/doc/osal-common.doxyfile | ||
PROJECT_NAME = "Core Flight Executive OSAL API Guide" | ||
OUTPUT_DIRECTORY = osalguide | ||
GENERATE_LATEX = YES | ||
|
||
# Main page for the osal guide | ||
INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/osalmain.dox | ||
INPUT += @MISSION_SOURCE_DIR@/cfe/docs/src/osalguide.dox | ||
|
||
#PREDEFINED | ||
PREDEFINED += @OSALGUIDE_PREDEFINED@ | ||
|
||
# Bring in the cFE header files for the documentation of the various API calls | ||
INPUT += \ | ||
@MISSION_OSAL_HEADERFILES@ \ | ||
@OSAL_MISC_ADDITION@ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.