Giter Club home page Giter Club logo

mongodb-docs's Introduction

mongodb-docs

Automates doxygen document generation for mongodb

Prerequisites

  1. cmake >= 3.8.0
  2. doxygen >= 1.8.13
  3. graphviz >= 2.40.1

Build documentation

$ mkdir ./build
$ cd ./build && cmake .. && make

or just

./build.sh

Documentation directory

start with ./build/docs/html/index.html

Where to find MongoDB source

  1. The environment variable $MONGODB_ROOT
  2. ~/mongo
  3. https://github.com/mongodb/mongo

What are documented and what features are included

  1. All public/protected/private members
  2. All namespaces includig anonymous namespaces
  3. C/C++ source code and *.md below following directories
    • mongo/src/mongo/base
    • mongo/src/mongo/bson
    • mongo/src/mongo/crypto
    • mongo/src/mongo/db
    • mongo/src/mongo/dbtests
    • mongo/src/mongo/embedded
    • mongo/src/mongo/executor
    • mongo/src/mongo/idl
    • mongo/src/mongo/logv2
    • mongo/src/mongo/platform
    • mongo/src/mongo/rpc
    • mongo/src/mongo/s
    • mongo/src/mongo/stdx
    • mongo/src/mongo/transport
    • mongo/src/mongo/unittest
    • mongo/src/mongo/util
  4. *.md below mongo/docs
  5. Source browser
  6. Symbol & file search
  7. Inheritance diagram & collaboration diagram
  8. Include dependency diagram
  9. Interactive diagram through SVG

Supported platforms for build

  1. Ubuntu 18.04
  2. Homebrew on MacOS X Catalina

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.