rizin
rizin copied to clipboard
Add simple linter checking Doxygen correctness and syntax
We have \param syntax in the developers documents but still a bunch of @param in the code. Simple Python script to check for those could help a lot.
ℤ rg "@param" -l
subprojects/rzwinkd/iob_net.c
librz/debug/p/native/linux/linux_debug.c
librz/debug/trace.c
librz/include/rz_core.h
librz/include/rz_util/rz_annotated_code.h
librz/include/rz_util/rz_spaces.h
librz/include/rz_util/rz_graph_drawable.h
librz/include/rz_project.h
librz/config/serialize_config.c
librz/bin/dwarf.c
librz/bin/p/bin_qnx.c
librz/analysis/p/analysis_x86_cs.c
librz/analysis/class.c
librz/analysis/rtti_itanium.c
librz/core/cannotated_code.c
hey @XVilka is this issue still open i would like to work on this issue
@KekmaTime go ahead
At first I wondered if using Tree-Sitter-based parser could help but apparently there is none for Doxygen yet: https://github.com/tree-sitter/tree-sitter-cpp/issues/116
See https://github.com/tree-sitter/tree-sitter-cpp/issues/116#issuecomment-1692987947