rizinorg / rizin

UNIX-like reverse engineering framework and command-line toolset.
https://rizin.re
GNU Lesser General Public License v3.0
2.71k stars 361 forks source link

Add simple linter checking Doxygen correctness and syntax #3572

Open XVilka opened 1 year ago

XVilka commented 1 year ago

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
KekmaTime commented 1 year ago

hey @XVilka is this issue still open i would like to work on this issue

XVilka commented 1 year ago

@KekmaTime go ahead

XVilka commented 1 year ago

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

Maijin commented 9 months ago

See https://github.com/tree-sitter/tree-sitter-cpp/issues/116#issuecomment-1692987947