The project yaml configuration file defines how your documentation will look.
For each version, you can select which configuration file to use.
You can either select a configuration file from your repository, or from several alternatives we store in our database:
Default Configuration
sidebar:
Basic Tutorial:
- Getting Started: readme.md
- Changelog: CHANGELOG.md
- Features: doc/features.md
- Tutorial: doc/tutorial.md
Advanced Tutorial:
- Pointer: doc/pointer.md
- Stream: doc/stream.md
- Encoding: doc/encoding.md
- Dom: doc/dom.md
- Sax: doc/sax.md
- Schema: doc/schema.md
- Performance: doc/performance.md
- Internals: doc/internals.md
- Faq: doc/faq.md
Examples:
- tutorial.cpp: example/tutorial/tutorial.cpp
- simplereader.cpp: example/simplereader/simplereader.cpp
- condense.cpp: example/condense/condense.cpp
- pretty.cpp: example/pretty/pretty.cpp
- capitalize.cpp: example/capitalize/capitalize.cpp
- messagereader.cpp: example/messagereader/messagereader.cpp
- serialize.cpp: example/serialize/serialize.cpp
- jsonx.cpp: example/jsonx/jsonx.cpp
- schemavalidator.cpp: example/schemavalidator/schemavalidator.cpp
- prettyauto.cpp: example/prettyauto/prettyauto.cpp
- parsebyparts.cpp: example/parsebyparts/parsebyparts.cpp
- filterkey.cpp: example/filterkey/filterkey.cpp
- filterkeydom.cpp: example/filterkeydom/filterkeydom.cpp
- sortkeys.cpp: example/sortkeys/sortkeys.cpp
- simplewriter.cpp: example/simplewriter/simplewriter.cpp
- simpledom.cpp: example/simpledom/simpledom.cpp
Extra:
- License: license.txt
- Presentation: https://www.slideshare.net/miloyip/how-to-write-the-fastest-json-parser-writer-in-the-world-20150328
- Related Projects: wiki/Related-Projects.md
Important API:
- GenericDocument: api/rapidjson/GenericDocument
- GenericStringBuffer: api/rapidjson/GenericStringBuffer
- GenericValue: api/rapidjson/GenericValue
- Writer: api/rapidjson/Writer
autodocSettings:
Public API:
baseUrl: api
language: cpp
INPUT: include/rapidjson
EXCLUDE: include/rapidjson/fwd.h
EXCLUDE_PATTERNS: '*/tests/* */test/*'
EXAMPLE_PATH: examples
includeApi: []
excludeApi: []
documentSingleUnderscore: true
documentStatic: true
documentProtected: true
extractNonDocComments: false
ENABLE_PREPROCESSING: 'YES'
MACRO_EXPANSION: 'YES'
EXPAND_ONLY_PREDEF: 'YES'
PREDEFINED:
- RAPIDJSON_DOXYGEN_RUNNING
- RAPIDJSON_NAMESPACE_BEGIN="namespace rapidjson {"
- RAPIDJSON_NAMESPACE_END="}"
- RAPIDJSON_REMOVEFPTR_(x)=x
- RAPIDJSON_ENABLEIF_RETURN(cond,returntype)="RAPIDJSON_REMOVEFPTR_ returntype"
- RAPIDJSON_DISABLEIF_RETURN(cond,returntype)="RAPIDJSON_REMOVEFPTR_ returntype"
SEARCH_INCLUDES: 'YES'
INCLUDE_PATH: ''
INCLUDE_FILE_PATTERNS: ''
ALIASES: ''
EXPAND_AS_DEFINED:
- RAPIDJSON_NOEXCEPT
SKIP_FUNCTION_MACROS: 'YES'
additionalSettings:
wiki_repo_path: wiki
#1 Alternative Configuration
Yaml configuration file is empty
#2 Alternative Configuration
Yaml configuration file is empty
#3 Alternative Configuration
Yaml configuration file is empty