Public Member Functions
	__init__ (self, search_dir, out_dir, main_file)

	extract (self, file, contents)

	update_main (self, doxygen_refs)

	build (self)

Public Attributes
	search_dir

	out_dir

	main_file

	all_sources

Detailed Description

A class used to build documentation for an ICP implementation.

...

Attributes
----------
search_dir : str
    The directory to search for source files.
out_dir : str
    The directory to write the output markdown files.
main_file : str
    The main documentation file.
all_sources : set
    A set of all sources found in the source files.
registration_names : dict
    Associates each ICP type name with its registration name.

Methods
-------
extract(file, contents):
    Extracts the documentation from the given file contents and writes it to a markdown file.
build():
    Searches for source files in the search directory and extracts their documentation.

Definition at line 16 of file icp_doc_builder.py.

Constructor & Destructor Documentation

◆ init()

icp_doc_builder.ICPDocumentationBuilder.__init__	(	self,
		search_dir,
		out_dir,
		main_file
	)

Constructs a new ICPDocumentationBuilder.

Parameters
----------
search_dir : str
    The directory to search for source files.
out_dir : str
    The directory to write the output markdown files.
main_file : str
    A path to the main markdown file.

Definition at line 43 of file icp_doc_builder.py.

Member Function Documentation

◆ build()

icp_doc_builder.ICPDocumentationBuilder.build ( self )

Searches for source files in the search directory and extracts their documentation.

Definition at line 180 of file icp_doc_builder.py.

◆ extract()

icp_doc_builder.ICPDocumentationBuilder.extract	(	self,
		file,
		contents
	)

Extracts the documentation from the given file contents and writes it to a markdown file.

Parameters
----------
file : str
    The name of the file to extract documentation from.
contents : str
    The contents of the file.

Definition at line 61 of file icp_doc_builder.py.

◆ update_main()

icp_doc_builder.ICPDocumentationBuilder.update_main	(	self,
		doxygen_refs
	)

Definition at line 152 of file icp_doc_builder.py.

Member Data Documentation

◆ all_sources

icp_doc_builder.ICPDocumentationBuilder.all_sources

Definition at line 59 of file icp_doc_builder.py.

◆ main_file

icp_doc_builder.ICPDocumentationBuilder.main_file

Definition at line 58 of file icp_doc_builder.py.

◆ out_dir

icp_doc_builder.ICPDocumentationBuilder.out_dir

Definition at line 57 of file icp_doc_builder.py.

◆ search_dir

icp_doc_builder.ICPDocumentationBuilder.search_dir

Definition at line 56 of file icp_doc_builder.py.

The documentation for this class was generated from the following file:

script/icp_doc_builder.py

Public Member Functions

Public Attributes