doxy_py_checker.py File Reference

Check parameter and return value for valid doxygen specification in python files. More...

Go to the source code of this file.

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

Namespaces
namespace	Documentation
namespace	Documentation.DoxygenCreator
namespace	Documentation.DoxygenCreator.doxy_py_checker

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

Check parameter and return value for valid doxygen specification in python files.

---

Definition in file doxy_py_checker.py.