tools::dox_extract::dox_extract Class Reference

List of all members.

Public Member Functions
def	__init__
def	clean_line
def	remove_unnecessary_whitespace
def	remove_dox_symbols
def	getDoxygenComment
Public Attributes
	is_a_function
	is_a_blank_line
	line_begins_with_white_space
	contains_end_block_dox_comment
	contains_start_block_dox_comment
	contains_three_slash_dox_comment
	dox_symbols

---

Constructor & Destructor Documentation

def tools::dox_extract::dox_extract::__init__

(

self

)

---

Member Function Documentation

def tools::dox_extract::dox_extract::clean_line	(		self,
			line
	)

def tools::dox_extract::dox_extract::getDoxygenComment	(		self,
			file_name,
			line_number
	)

Search and return doxygen comments at given file/line position and return them
    Note: - line is a number in string form here.
  - if no appropriate comments could be found (or result is empty) function should return  file_ + ':' + line  string

def tools::dox_extract::dox_extract::remove_dox_symbols	(		self,
			lines
	)

def tools::dox_extract::dox_extract::remove_unnecessary_whitespace	(		self,
			lines
	)

---

Member Data Documentation

tools::dox_extract::dox_extract::contains_end_block_dox_comment

tools::dox_extract::dox_extract::contains_start_block_dox_comment

tools::dox_extract::dox_extract::contains_three_slash_dox_comment

tools::dox_extract::dox_extract::dox_symbols

tools::dox_extract::dox_extract::is_a_blank_line

tools::dox_extract::dox_extract::is_a_function

tools::dox_extract::dox_extract::line_begins_with_white_space

---

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

• src/python/bindings/tools/dox_extract.py