Skip to content

Commit c2cd460

Browse files
committed
Add docs build.
1 parent 2b0cdb7 commit c2cd460

File tree

4 files changed

+14
-4
lines changed

4 files changed

+14
-4
lines changed

.github/workflows/build.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,11 @@ jobs:
136136
EOF
137137
cp ${{ matrix.example }}/* example/src/
138138
platformio run -d example
139+
build_docs:
140+
runs-on: ubuntu-latest
141+
steps:
142+
- uses: actions/checkout@v2
143+
- name: Doxygen Action
144+
uses: mattnotmitt/doxygen-action@v1.9.1
145+
with:
146+
working-directory: 'docs/'

docs/Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ PROJECT_LOGO =
5858
# entered, it will be relative to the location where doxygen was started. If
5959
# left blank the current directory will be used.
6060

61-
OUTPUT_DIRECTORY = docs
61+
OUTPUT_DIRECTORY = doxydocs
6262

6363
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
6464
# directories (in 2 levels) under the output directory of each output format and
@@ -836,7 +836,7 @@ WARN_NO_PARAMDOC = NO
836836
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
837837
# The default value is: NO.
838838

839-
WARN_AS_ERROR = FAIL_ON_WARNINGS
839+
WARN_AS_ERROR = YES
840840

841841
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
842842
# can produce. The string should contain the $file, $line, and $text tags, which

src/NimBLEDevice.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,8 @@ class NimBLEDevice {
151151
int max_events = 0);
152152
static bool stopAdvertising(uint8_t inst_id);
153153
static bool stopAdvertising();
154-
# else
154+
# endif
155+
# if !CONFIG_BT_NIMBLE_EXT_ADV || defined(_DOXYGEN_)
155156
static NimBLEAdvertising* getAdvertising();
156157
static bool startAdvertising();
157158
static bool stopAdvertising();

src/NimBLEServer.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ class NimBLEServer {
5858
int duration = 0,
5959
int max_events = 0);
6060
bool stopAdvertising(uint8_t inst_id);
61-
#else
61+
#endif
62+
#if !CONFIG_BT_NIMBLE_EXT_ADV || defined(_DOXYGEN_)
6263
NimBLEAdvertising* getAdvertising();
6364
bool startAdvertising();
6465
#endif

0 commit comments

Comments
 (0)