Skip to content

Commit 0c9018e

Browse files
committed
CXX-38 make the documentation better
- Create a docs folder for future use and for placing doxygen output - Take ownership of the doxygenConfig and tweak some settings - Document the mongo and mongo::client namespaces so functions inside of them are documented
1 parent 18fe351 commit 0c9018e

File tree

3 files changed

+15
-7
lines changed

3 files changed

+15
-7
lines changed

docs/.gitkeep

Whitespace-only changes.

doxygenConfig

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# Project related configuration options
33
#---------------------------------------------------------------------------
44
DOXYFILE_ENCODING = UTF-8
5-
PROJECT_NAME = MongoDB
6-
PROJECT_NUMBER = 2.6.0-rc0
5+
PROJECT_NAME = MongoDB C++ Driver
6+
PROJECT_NUMBER = 0.0
77
OUTPUT_DIRECTORY = docs/doxygen
88
CREATE_SUBDIRS = NO
99
OUTPUT_LANGUAGE = English
@@ -31,7 +31,7 @@ QT_AUTOBRIEF = NO
3131
MULTILINE_CPP_IS_BRIEF = NO
3232
INHERIT_DOCS = YES
3333
SEPARATE_MEMBER_PAGES = NO
34-
TAB_SIZE = 8
34+
TAB_SIZE = 4
3535
ALIASES =
3636
OPTIMIZE_OUTPUT_FOR_C = NO
3737
OPTIMIZE_OUTPUT_JAVA = NO
@@ -51,9 +51,6 @@ SYMBOL_CACHE_SIZE = 0
5151
# Build related configuration options
5252
#---------------------------------------------------------------------------
5353

54-
# ***
55-
# ERH - this controls whether all classes in files are documented or just the ones with tags
56-
# ***
5754
EXTRACT_ALL = NO
5855

5956
EXTRACT_PRIVATE = NO
@@ -313,4 +310,4 @@ DOT_CLEANUP = YES
313310
#---------------------------------------------------------------------------
314311
# Options related to the search engine
315312
#---------------------------------------------------------------------------
316-
SEARCHENGINE = NO
313+
SEARCHENGINE = YES

src/mongo/client/init.h

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// @file init.h
2+
13
/* Copyright 2013 10gen Inc.
24
*
35
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,7 +24,16 @@
2224
// library. The below functions are not defined in servers like mongos or mongod, which have
2325
// their own initialization strategy.
2426

27+
/**
28+
* @namespace mongo
29+
* @brief the main MongoDB namespace
30+
*/
2531
namespace mongo {
32+
33+
/**
34+
* @namespace mongo::client
35+
* @brief the MongoDB C++ driver namespace
36+
*/
2637
namespace client {
2738

2839
const int kDefaultShutdownGracePeriodMillis = 250;

0 commit comments

Comments
 (0)