Skip to content

Commit aaf83dd

Browse files
committed
Improve docs.
1 parent 5b0eea4 commit aaf83dd

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

libs/client-sdk/Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -829,7 +829,7 @@ WARN_LOGFILE =
829829
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
830830
# Note: If this tag is empty the current directory is searched.
831831

832-
INPUT = include src
832+
INPUT = include src docs ../common/include ../common/src
833833

834834
# This tag can be used to specify the character encoding of the source files
835835
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1026,7 +1026,7 @@ FILTER_SOURCE_PATTERNS =
10261026
# (index.html). This can be useful if you have a project on for instance GitHub
10271027
# and want to reuse the introduction page also for the doxygen output.
10281028

1029-
USE_MDFILE_AS_MAINPAGE = docs/mainpage.md
1029+
USE_MDFILE_AS_MAINPAGE = ./docs/doc.md
10301030

10311031
#---------------------------------------------------------------------------
10321032
# Configuration options related to source browsing

libs/client-sdk/docs/doc.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
11
# SDK Layout and Overview
2+
3+
## Basic Functionality
4+
5+
The following pages document the core of the API, every application will use these portions of the SDK:
6+
7+
- [Client](@ref launchdarkly::client_side::Client)
8+
- [Config Builder](@ref launchdarkly::config::detail::builders::ConfigBuilder)
9+
- [Context Builder](@ref launchdarkly::ContextBuilder)

0 commit comments

Comments
 (0)