Skip to content

Commit 0f54858

Browse files
author
Javier Gil Aviles
committed
Refs #22788: Minor fixes
Signed-off-by: Javier Gil Aviles <javiergil@eprosima.com>
1 parent f84c918 commit 0f54858

14 files changed

Lines changed: 154 additions & 1080 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
<a href="https://github.com/eProsima/FIWARE-DDS-Enabler/network/members"><img alt="Forks" src="https://img.shields.io/github/forks/eProsima/FIWARE-DDS-Enabler.svg"/></a>
2626
<a href="https://github.com/eProsima/FIWARE-DDS-Enabler/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/eProsima/FIWARE-DDS-Enabler.svg"/></a>
2727
<br>
28-
<a href="https://fiware-dds-enabler.readthedocs.io"><img alt="Documentation badge" src="https://img.shields.io/readthedocs/fiware-dds-enabler.svg"/></a>
28+
<a href="https://dds-enabler.readthedocs.io"><img alt="Documentation badge" src="https://img.shields.io/readthedocs/dds-enabler.svg"/></a>
2929
<a href="https://github.com/eProsima/FIWARE-DDS-Enabler/actions/workflows/nightly-windows-ci.yml"><img alt="Windows CI" src="https://img.shields.io/github/actions/workflow/status/eProsima/FIWARE-DDS-Enabler/nightly-windows-ci.yml?label=Windows%20CI"></a>
3030
<a href="https://github.com/eProsima/FIWARE-DDS-Enabler/actions/workflows/nightly-ubuntu-ci.yml"><img alt="Ubuntu CI" src="https://img.shields.io/github/actions/workflow/status/eProsima/FIWARE-DDS-Enabler/nightly-ubuntu-ci.yml?label=Ubuntu%20CI"></a>
3131
</div>

ddsenabler_docs/code/Doxyfile.in

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ CREATE_SUBDIRS = NO
9090
# Minimum value: 0, maximum value: 8, default value: 8.
9191
# This tag requires that the tag CREATE_SUBDIRS is set to YES.
9292

93-
CREATE_SUBDIRS_LEVEL = 8
93+
# CREATE_SUBDIRS_LEVEL = 8
9494

9595
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
9696
# characters to appear in the names of generated files. If set to NO, non-ASCII
@@ -372,7 +372,7 @@ TOC_INCLUDE_HEADINGS = 0
372372
# The default value is: DOXYGEN.
373373
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
374374

375-
MARKDOWN_ID_STYLE = DOXYGEN
375+
# MARKDOWN_ID_STYLE = DOXYGEN
376376

377377
# When enabled doxygen tries to link words that correspond to documented
378378
# classes, or namespaces to their corresponding documentation. Such a link can
@@ -504,7 +504,7 @@ NUM_PROC_THREADS = 1
504504
# Possible values are: YES, NO, DATETIME and DATE.
505505
# The default value is: NO.
506506

507-
TIMESTAMP = NO
507+
# TIMESTAMP = NO
508508

509509
#---------------------------------------------------------------------------
510510
# Build related configuration options
@@ -649,7 +649,7 @@ HIDE_COMPOUND_REFERENCE= NO
649649
# will show which file needs to be included to use the class.
650650
# The default value is: YES.
651651

652-
SHOW_HEADERFILE = YES
652+
# SHOW_HEADERFILE = YES
653653

654654
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
655655
# the files that are included by a file in the documentation of that file.
@@ -867,7 +867,7 @@ WARN_IF_DOC_ERROR = YES
867867
# parameters have no documentation without warning.
868868
# The default value is: YES.
869869

870-
WARN_IF_INCOMPLETE_DOC = YES
870+
# WARN_IF_INCOMPLETE_DOC = YES
871871

872872
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
873873
# are documented, but have no documentation for their parameters or return
@@ -885,7 +885,7 @@ WARN_NO_PARAMDOC = YES
885885
# will automatically be disabled.
886886
# The default value is: NO.
887887

888-
WARN_IF_UNDOC_ENUM_VAL = NO
888+
# WARN_IF_UNDOC_ENUM_VAL = NO
889889

890890
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
891891
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
@@ -922,7 +922,7 @@ WARN_FORMAT = "$file:$line: $text"
922922
# See also: WARN_FORMAT
923923
# The default value is: at line $line of file $file.
924924

925-
WARN_LINE_FORMAT = "at line $line of file $file"
925+
# WARN_LINE_FORMAT = "at line $line of file $file"
926926

927927
# The WARN_LOGFILE tag can be used to specify a file to which warning and error
928928
# messages should be written. If left blank the output is written to standard
@@ -963,7 +963,7 @@ INPUT_ENCODING = UTF-8
963963
# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
964964
# "INPUT_ENCODING" for further information on supported encodings.
965965

966-
INPUT_FILE_ENCODING =
966+
# INPUT_FILE_ENCODING =
967967

968968
# If the value of the INPUT tag contains directories, you can use the
969969
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
@@ -1162,7 +1162,7 @@ USE_MDFILE_AS_MAINPAGE =
11621162
# be processed before the automatic comment starts.
11631163
# Minimum value: 7, maximum value: 10000, default value: 72.
11641164

1165-
FORTRAN_COMMENT_AFTER = 72
1165+
# FORTRAN_COMMENT_AFTER = 72
11661166

11671167
#---------------------------------------------------------------------------
11681168
# Configuration options related to source browsing
@@ -1415,7 +1415,7 @@ HTML_EXTRA_FILES =
14151415
# The default value is: AUTO_LIGHT.
14161416
# This tag requires that the tag GENERATE_HTML is set to YES.
14171417

1418-
HTML_COLORSTYLE = AUTO_LIGHT
1418+
# HTML_COLORSTYLE = AUTO_LIGHT
14191419

14201420
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
14211421
# will adjust the colors in the style sheet and background images according to
@@ -1471,7 +1471,7 @@ HTML_DYNAMIC_SECTIONS = NO
14711471
# The default value is: YES.
14721472
# This tag requires that the tag GENERATE_HTML is set to YES.
14731473

1474-
HTML_CODE_FOLDING = YES
1474+
# HTML_CODE_FOLDING = YES
14751475

14761476
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
14771477
# shown in the various tree structured indices initially; the user can expand
@@ -1514,7 +1514,7 @@ DOCSET_FEEDNAME = "Doxygen generated docs"
15141514
# (such as a company or product suite) can be grouped.
15151515
# This tag requires that the tag GENERATE_DOCSET is set to YES.
15161516

1517-
DOCSET_FEEDURL =
1517+
# DOCSET_FEEDURL =
15181518

15191519
# This tag specifies a string that should uniquely identify the documentation
15201520
# set bundle. This should be a reverse domain-name style string, e.g.
@@ -1611,7 +1611,7 @@ TOC_EXPAND = NO
16111611
# protocol see https://www.sitemaps.org
16121612
# This tag requires that the tag GENERATE_HTML is set to YES.
16131613

1614-
SITEMAP_URL =
1614+
# SITEMAP_URL =
16151615

16161616
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
16171617
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
@@ -1735,7 +1735,7 @@ GENERATE_TREEVIEW = NO
17351735
# The default value is: NO.
17361736
# This tag requires that the tag GENERATE_HTML is set to YES.
17371737

1738-
FULL_SIDEBAR = NO
1738+
# FULL_SIDEBAR = NO
17391739

17401740
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
17411741
# doxygen will group on one line in the generated HTML documentation.
@@ -1766,7 +1766,7 @@ EXT_LINKS_IN_WINDOW = NO
17661766
# The default value is: YES.
17671767
# This tag requires that the tag GENERATE_HTML is set to YES.
17681768

1769-
OBFUSCATE_EMAILS = YES
1769+
# OBFUSCATE_EMAILS = YES
17701770

17711771
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
17721772
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
@@ -1814,7 +1814,7 @@ USE_MATHJAX = NO
18141814
# The default value is: MathJax_2.
18151815
# This tag requires that the tag USE_MATHJAX is set to YES.
18161816

1817-
MATHJAX_VERSION = MathJax_2
1817+
# MATHJAX_VERSION = MathJax_2
18181818

18191819
# When MathJax is enabled you can set the default output format to be used for
18201820
# the MathJax output. For more details about the output format see MathJax
@@ -2311,23 +2311,23 @@ GENERATE_AUTOGEN_DEF = NO
23112311
# database with symbols found by doxygen stored in tables.
23122312
# The default value is: NO.
23132313

2314-
GENERATE_SQLITE3 = NO
2314+
# GENERATE_SQLITE3 = NO
23152315

23162316
# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
23172317
# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
23182318
# in front of it.
23192319
# The default directory is: sqlite3.
23202320
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
23212321

2322-
SQLITE3_OUTPUT = sqlite3
2322+
# SQLITE3_OUTPUT = sqlite3
23232323

23242324
# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
23252325
# database file will be recreated with each doxygen run. If set to NO, doxygen
23262326
# will warn if an a database file is already found and not modify it.
23272327
# The default value is: YES.
23282328
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
23292329

2330-
SQLITE3_RECREATE_DB = YES
2330+
# SQLITE3_RECREATE_DB = YES
23312331

23322332
#---------------------------------------------------------------------------
23332333
# Configuration options related to the Perl module output
@@ -2535,7 +2535,7 @@ DOT_NUM_THREADS = 0
25352535
# The default value is: fontname=Helvetica,fontsize=10.
25362536
# This tag requires that the tag HAVE_DOT is set to YES.
25372537

2538-
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2538+
# DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
25392539

25402540
# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
25412541
# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
@@ -2544,15 +2544,15 @@ DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
25442544
# The default value is: labelfontname=Helvetica,labelfontsize=10.
25452545
# This tag requires that the tag HAVE_DOT is set to YES.
25462546

2547-
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
2547+
# DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
25482548

25492549
# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
25502550
# around nodes set 'shape=plain' or 'shape=plaintext' <a
25512551
# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
25522552
# The default value is: shape=box,height=0.2,width=0.4.
25532553
# This tag requires that the tag HAVE_DOT is set to YES.
25542554

2555-
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
2555+
# DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
25562556

25572557
# You can set the path where dot can find font specified with fontname in
25582558
# DOT_COMMON_ATTR and others dot attributes.
@@ -2718,7 +2718,7 @@ DIRECTORY_GRAPH = YES
27182718
# Minimum value: 1, maximum value: 25, default value: 1.
27192719
# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
27202720

2721-
DIR_GRAPH_MAX_DEPTH = 1
2721+
# DIR_GRAPH_MAX_DEPTH = 1
27222722

27232723
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
27242724
# generated by dot. For an explanation of the image formats see the section
@@ -2852,7 +2852,7 @@ DOT_CLEANUP = YES
28522852
# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
28532853
# output file formats "png", "eps", "svg", and "ismap".
28542854

2855-
MSCGEN_TOOL =
2855+
# MSCGEN_TOOL =
28562856

28572857
# The MSCFILE_DIRS tag can be used to specify one or more directories that
28582858
# contain msc files that are included in the documentation (see the \mscfile

ddsenabler_docs/ddseabler/CBCallbacks.hpp

Lines changed: 0 additions & 83 deletions
This file was deleted.
1.01 KB
Loading

ddsenabler_docs/docs/appendixes/glossary.rst

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)