Documentation.DoxygenCreator.doxy_py_checker Namespace Reference

Classes
class	DoxyPyChecker
	Doxygen documentation checker class. More...

Variables
	args = doxy_checker.get_cmd_args()
bool	CHECK_TYPING = False
	doxy_checker = DoxyPyChecker(path="../../", print_checked_files=False)
str	INIT_FUNCTION = "__init__"
list	L_EXCLUDE_FOLDER = [".venv", "Documentation"]
list	L_IGNORE_PARAM = ["self", "cls"]
	log = logging.getLogger("DoxyPyChecker")
str	PARAM_DOC_PREFIX = "@param"
str	RETURN_DOC_PREFIX = "@return"
str	S_DEFAULT_PATH = "./"
	s_path

Detailed Description

---

Variable Documentation

args

args = doxy_checker.get_cmd_args()

Definition at line 219 of file doxy_py_checker.py.

CHECK_TYPING

bool CHECK_TYPING = False

Definition at line 24 of file doxy_py_checker.py.

doxy_checker

doxy_checker = DoxyPyChecker(path="../../", print_checked_files=False)

Definition at line 218 of file doxy_py_checker.py.

INIT_FUNCTION

str INIT_FUNCTION = "__init__"

Definition at line 21 of file doxy_py_checker.py.

L_EXCLUDE_FOLDER

list L_EXCLUDE_FOLDER = [".venv", "Documentation"]

Definition at line 22 of file doxy_py_checker.py.

L_IGNORE_PARAM

list L_IGNORE_PARAM = ["self", "cls"]

Definition at line 18 of file doxy_py_checker.py.

log

log = logging.getLogger("DoxyPyChecker")

Definition at line 15 of file doxy_py_checker.py.

PARAM_DOC_PREFIX

str PARAM_DOC_PREFIX = "@param"

Definition at line 19 of file doxy_py_checker.py.

RETURN_DOC_PREFIX

str RETURN_DOC_PREFIX = "@return"

Definition at line 20 of file doxy_py_checker.py.

S_DEFAULT_PATH

str S_DEFAULT_PATH = "./"

Definition at line 17 of file doxy_py_checker.py.

s_path

s_path

Definition at line 221 of file doxy_py_checker.py.