erkin yucel / mbed-os

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

Embed: (wiki syntax)

« Back to documentation index

docs_gen Namespace Reference

docs_gen Namespace Reference

Functions

def generate_documentation

Detailed Description

An api for generating documentation from the codebase

Function Documentation

def docs_gen::generate_documentation (   dirs,
  output_dir 
)
Use doxygen to generate the documentation

Positional arguments:
dirs - the directories that doxygen should scan for documentation
output_dir - location of the documentation after the return of this function

Definition at line 10 of file docs_gen.py.