Drogon logo

Versions

Version Name Build Status Last Built Cfg File
master latest Success With Warnings 3 days, 4 hours ago Default
v1.0.0 Success With Warnings 3 days, 4 hours ago Default
(*) If you have multiple versions, the primary version (latest tag) defines which version the users will see when they enter the project.

Configurations Files

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:


#1 Alternative Configuration

Yaml configuration file is empty

#2 Alternative Configuration

Yaml configuration file is empty
Download

#3 Alternative Configuration

sidebar:
  Basic Tutorial:
  - Getting Started: README.md
  - License: LICENSE
  Wiki:
  - Overview: wiki/01-Overview.md
  - Installation: wiki/02 Installation.md
  - Quick Start: wiki/03 Quick-Start.md
  - Controller Introduction:
    - index: wiki/04.0-Controller-Introduction.md
    - Controller HttpSimpleController: wiki/04.1-Controller-HttpSimpleController.md
    - Controller HttpController: wiki/04.2-Controller-HttpController.md
    - Controller WebSocketController: wiki/04.3-Controller-WebSocketController.md
  - Filter: wiki/05 Filter.md
  - View: wiki/06 View.md
  - Session: wiki/07 Session.md
  - Database General:
    - index: wiki/08.0 Database-General.md
    - DataBase DbClient: wiki/08.1 DataBase-DbClient.md
    - DataBase Transaction: wiki/08.2 DataBase-Transaction.md
    - DataBase ORM: wiki/08.3 DataBase-ORM.md
    - DataBase FastDbClient: wiki/08.4 DataBase-FastDbClient.md
  - Plugins: wiki/09 Plugins.md
  - Configuration File: wiki/10 Configuration-File.md
  - Drogon Ctl Command: wiki/11 drogon_ctl Command.md
  - AOP Aspect Oriented Programming: wiki/12 AOP Aspect Oriented Programming.md
  - Benchmarks: wiki/13 Benchmarks.md
  - Coz profiling: wiki/14-Coz.md
  Important API:
  - HttpController: api/drogon/HttpController
  - HttpAppFramework: api/drogon/HttpAppFramework
  - HttpRequest: api/drogon/HttpRequest
  - HttpResponse: api/drogon/HttpResponse
  - HttpClient: api/drogon/HttpClient
  - CacheMap: api/drogon/CacheMap
  - Cookie: api/drogon/Cookie
  - HttpFilter: api/drogon/HttpFilter
  - HttpSimpleController: api/drogon/HttpSimpleController
  - WebSocketClient: api/drogon/WebSocketClient


autodocSettings:
  Public API:
    baseUrl: api
    language: cpp
    INPUT: lib/inc/drogon orm_lib/inc/drogon/orm
    EXCLUDE: test tests examples
    EXCLUDE_PATTERNS: '*/tests/* */test/*'
    EXAMPLE_PATH: examples
    includeApi:
    - drogon
    excludeApi:
    - drogon/internal
    documentSingleUnderscore: true
    documentStatic: true
    documentProtected: true
    extractNonDocComments: false
    ENABLE_PREPROCESSING: 'YES'
    MACRO_EXPANSION: 'NO'
    EXPAND_ONLY_PREDEF: 'NO'
    PREDEFINED: ''
    SEARCH_INCLUDES: 'YES'
    INCLUDE_PATH: ''
    INCLUDE_FILE_PATTERNS: ''


additionalSettings:
  wiki_repo_path: wiki