Skip to content

Commit 9d5c30b

Browse files
authored
docs: standardize Doxyfile and README for vcpkg deployment (#431)
* docs: standardize Doxyfile and README for vcpkg deployment - Set TIMESTAMP=NO for reproducible builds - Add QT_AUTOBRIEF=NO, WARN_IF_INCOMPLETE_DOC=YES - Add *.md to FILE_PATTERNS - Remove redundant mainpage.dox from INPUT - Add missing HTML settings (COLORSTYLE, CODE_FOLDING, SIDEBAR) - Standardize EXCLUDE_PATTERNS - Add vcpkg install instructions to README Quick Start Closes #430 * docs(headers): add @code usage example to main public header Relates to #430
1 parent 55ac9bf commit 9d5c30b

3 files changed

Lines changed: 33 additions & 4 deletions

File tree

Doxyfile

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ INLINE_INHERITED_MEMB = NO
2323
FULL_PATH_NAMES = YES
2424
SHORT_NAMES = NO
2525
JAVADOC_AUTOBRIEF = NO
26+
QT_AUTOBRIEF = NO
2627
MULTILINE_CPP_IS_BRIEF = YES
2728
INHERIT_DOCS = YES
2829
SEPARATE_MEMBER_PAGES = NO
@@ -46,7 +47,7 @@ INLINE_SIMPLE_STRUCTS = NO
4647
TYPEDEF_HIDES_STRUCT = NO
4748
LOOKUP_CACHE_SIZE = 0
4849
NUM_PROC_THREADS = 1
49-
TIMESTAMP = YES
50+
TIMESTAMP = NO
5051
EXTRACT_ALL = YES
5152
EXTRACT_PRIVATE = YES
5253
EXTRACT_STATIC = YES
@@ -89,15 +90,15 @@ WARN_IF_UNDOCUMENTED = YES
8990
WARN_IF_DOC_ERROR = YES
9091
WARN_NO_PARAMDOC = YES
9192
WARN_AS_ERROR = NO
93+
WARN_IF_INCOMPLETE_DOC = YES
9294
WARN_FORMAT = "$file:$line: $text"
9395
WARN_LOGFILE =
9496
INPUT = ./core \
9597
./values \
9698
./internal \
9799
./integration \
98100
./examples \
99-
./utilities \
100-
./mainpage.dox
101+
./utilities
101102

102103
INPUT_ENCODING = UTF-8
103104
FILE_PATTERNS = *.c \
@@ -108,7 +109,8 @@ FILE_PATTERNS = *.c \
108109
*.hh \
109110
*.hpp \
110111
*.tpp \
111-
*.cppm
112+
*.cppm \
113+
*.md
112114

113115
RECURSIVE = YES
114116
EXCLUDE = build \
@@ -120,6 +122,8 @@ EXCLUDE_SYMLINKS = NO
120122
EXCLUDE_PATTERNS = */build/* \
121123
*/vcpkg/* \
122124
*/.git/* \
125+
*/_deps/* \
126+
*/node_modules/* \
123127
*/.*
124128

125129
EXCLUDE_SYMBOLS =
@@ -160,6 +164,9 @@ HTML_EXTRA_FILES =
160164
HTML_COLORSTYLE_HUE = 220
161165
HTML_COLORSTYLE_SAT = 100
162166
HTML_COLORSTYLE_GAMMA = 80
167+
HTML_COLORSTYLE = AUTO_LIGHT
168+
HTML_CODE_FOLDING = YES
169+
FULL_SIDEBAR = NO
163170
HTML_TIMESTAMP = NO
164171
HTML_DYNAMIC_MENUS = YES
165172
HTML_DYNAMIC_SECTIONS = NO

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,18 @@ messaging_system, network_system, database_system
7575

7676
## Quick Start
7777

78+
### Installation via vcpkg
79+
80+
```bash
81+
vcpkg install kcenon-container-system
82+
```
83+
84+
In your `CMakeLists.txt`:
85+
```cmake
86+
find_package(container_system CONFIG REQUIRED)
87+
target_link_libraries(your_target PRIVATE kcenon::container_system)
88+
```
89+
7890
### Basic Usage Example
7991

8092
```cpp

include/container/optimizations/fast_parser.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@
3232
/**
3333
* @file fast_parser.h
3434
* @brief Fast-path parsing utilities and configuration for the container system.
35+
*
36+
* @code
37+
* // Configure the fast parser and reserve container capacity
38+
* kcenon::container::parser_config config;
39+
* config.use_fast_path = true;
40+
* config.initial_capacity = 1024;
41+
*
42+
* std::vector<int> data;
43+
* kcenon::container::reserve_if_possible(data, config.initial_capacity);
44+
* @endcode
3545
*/
3646

3747
namespace kcenon::container {

0 commit comments

Comments
 (0)