Skip to content

Commit d45bc90

Browse files
committed
Doxygen fix.
1 parent 15822e8 commit d45bc90

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

Doxyfile

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ PROJECT_NAME = Commander-API
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = V0.2A
41+
PROJECT_NUMBER = V2.0.1
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a
4545
# quick idea about the purpose of the project. Keep the description short.
4646

47-
PROJECT_BRIEF = "Commander-API is a C API, that interprets character-based commands"
47+
PROJECT_BRIEF = "Commander-API is a C++ API, that parses character based commands."
4848

4949
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
5050
# in the documentation. The maximum height of the logo should not exceed 55
@@ -845,7 +845,7 @@ WARN_LOGFILE =
845845
# Note: If this tag is empty the current directory is searched.
846846

847847
INPUT = src \
848-
Doc/markdown_pages
848+
docs/markdown_pages
849849

850850
# This tag can be used to specify the character encoding of the source files
851851
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -986,7 +986,7 @@ EXAMPLE_RECURSIVE = NO
986986
# that contain images that are to be included in the documentation (see the
987987
# \image command).
988988

989-
IMAGE_PATH = Doc/images
989+
IMAGE_PATH = docs/images
990990

991991
# The INPUT_FILTER tag can be used to specify a program that doxygen should
992992
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1230,7 +1230,7 @@ HTML_FILE_EXTENSION = .html
12301230
# of the possible markers and block names see the documentation.
12311231
# This tag requires that the tag GENERATE_HTML is set to YES.
12321232

1233-
HTML_HEADER = Doc/Style/header.html
1233+
HTML_HEADER = docs/Style/header.html
12341234

12351235
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
12361236
# generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1265,9 +1265,9 @@ HTML_STYLESHEET =
12651265
# list). For an example see the documentation.
12661266
# This tag requires that the tag GENERATE_HTML is set to YES.
12671267

1268-
HTML_EXTRA_STYLESHEET = Doc/Style/custom.css \
1269-
Doc/Style/doxygen-awesome.css \
1270-
Doc/Style/doxygen-awesome-sidebar-only.css
1268+
HTML_EXTRA_STYLESHEET = docs/Style/custom.css \
1269+
docs/Style/doxygen-awesome.css \
1270+
docs/Style/doxygen-awesome-sidebar-only.css
12711271

12721272
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
12731273
# other source files which should be copied to the HTML output directory. Note

docs/html/_commander-_a_p_i_8hpp.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@
130130
</table><table class="memberdecls">
131131
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
132132
Macros</h2></td></tr>
133-
<tr class="memitem:a9dda1700b3dad0727a9042fec8405d53"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_commander-_a_p_i_8hpp.html#a9dda1700b3dad0727a9042fec8405d53">COMMANDER_API_VERSION</a>&#160;&#160;&#160;(const char*)&quot;2.0.0&quot;</td></tr>
133+
<tr class="memitem:a9dda1700b3dad0727a9042fec8405d53"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_commander-_a_p_i_8hpp.html#a9dda1700b3dad0727a9042fec8405d53">COMMANDER_API_VERSION</a>&#160;&#160;&#160;(const char*)&quot;2.0.1&quot;</td></tr>
134134
<tr class="separator:a9dda1700b3dad0727a9042fec8405d53"><td class="memSeparator" colspan="2">&#160;</td></tr>
135135
<tr class="memitem:aff2cdea04953244073599693c685043a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_commander-_a_p_i_8hpp.html#aff2cdea04953244073599693c685043a">apiElement</a>(name, desc, func)&#160;&#160;&#160;{ 0, NULL, NULL, (const char*)name, (const char*)desc, func }</td></tr>
136136
<tr class="memdesc:aff2cdea04953244073599693c685043a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Like STM32 Class Factory. <a href="_commander-_a_p_i_8hpp.html#aff2cdea04953244073599693c685043a">More...</a><br /></td></tr>
@@ -206,7 +206,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9dda1700b3dad0727a9042fe
206206
<div class="memproto">
207207
<table class="memname">
208208
<tr>
209-
<td class="memname">#define COMMANDER_API_VERSION&#160;&#160;&#160;(const char*)&quot;2.0.0&quot;</td>
209+
<td class="memname">#define COMMANDER_API_VERSION&#160;&#160;&#160;(const char*)&quot;2.0.1&quot;</td>
210210
</tr>
211211
</table>
212212
</div><div class="memdoc">

docs/html/_commander-_a_p_i_8hpp_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@
146146
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#ifndef COMMANDER_API_SRC_COMMANDER_HPP_</span></div>
147147
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define COMMANDER_API_SRC_COMMANDER_HPP_</span></div>
148148
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
149-
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="_commander-_a_p_i_8hpp.html#a9dda1700b3dad0727a9042fec8405d53"> 38</a></span>&#160;<span class="preprocessor">#define COMMANDER_API_VERSION (const char*)&quot;2.0.0&quot;</span></div>
149+
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="_commander-_a_p_i_8hpp.html#a9dda1700b3dad0727a9042fec8405d53"> 38</a></span>&#160;<span class="preprocessor">#define COMMANDER_API_VERSION (const char*)&quot;2.0.1&quot;</span></div>
150150
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
151151
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#include &quot;stdint.h&quot;</span></div>
152152
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#include &quot;string.h&quot;</span></div>

docs/html/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
<div class="title">Commander-API library </div> </div>
110110
</div><!--header-->
111111
<div class="contents">
112-
<div class="textblock"><p><b>Version V2.0.0</b></p>
112+
<div class="textblock"><p><b>Version V2.0.1</b></p>
113113
<p>Commander-API is a simple to use parser library and you can easily use it to process character based commands and link them to a specified function. It is designed mainly to work with low memory capacity devices, for example, <b>small ARM or AVR processors</b>.</p>
114114
<h2><a class="anchor" id="autotoc_md0"></a>
115115
Changes in V2</h2>

0 commit comments

Comments
 (0)