update_configuration_doc Namespace Reference

Classes
class	Message
class	ResolutionError
class	Resolver

Functions
def	GenerateDocumentation (output_file, root)
def	main ()
def	ParseProtoFile (proto_file)
def	ParseProtoFilesRecursively (root)

Variables
string	NODOC = 'Not yet documented.'
string	PREFIX
string	ROOT = 'cartographer'
string	SUFFIX
string	TARGET = 'docs/source/configuration.rst'

Function Documentation

def update_configuration_doc.GenerateDocumentation	(		output_file,
			root
	)

Recursively generates documentation, sorts and writes it.

Definition at line 175 of file update_configuration_doc.py.

def update_configuration_doc.main

(

)

Definition at line 204 of file update_configuration_doc.py.

def update_configuration_doc.ParseProtoFile

(

proto_file

)

Computes the list of Message objects of the option messages in a file.

Definition at line 66 of file update_configuration_doc.py.

def update_configuration_doc.ParseProtoFilesRecursively

(

root

)

Recursively parses all proto files into a list of Message objects.

Definition at line 140 of file update_configuration_doc.py.

Variable Documentation

string update_configuration_doc.NODOC = 'Not yet documented.'

Definition at line 48 of file update_configuration_doc.py.

string update_configuration_doc.PREFIX

Initial value:

= """.. Copyright 2016 The Cartographer Authors

.. Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

..      http://www.apache.org/licenses/LICENSE-2.0

.. Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

=============
Configuration
=============

.. DO NOT EDIT! This documentation is AUTOGENERATED, please edit .proto files as
.. needed and run scripts/update_configuration_doc.py.

"""

Definition at line 24 of file update_configuration_doc.py.

string update_configuration_doc.ROOT = 'cartographer'

Definition at line 23 of file update_configuration_doc.py.

string update_configuration_doc.SUFFIX

Initial value:

= """
"""

Definition at line 46 of file update_configuration_doc.py.

string update_configuration_doc.TARGET = 'docs/source/configuration.rst'

Definition at line 22 of file update_configuration_doc.py.