Skip to content

IgnoreMarkerOption

Michalis Kamburelis edited this page Aug 31, 2019 · 1 revision

Use --ignore-marker XXX to instruct PasDoc to explicitly ignore comments that start with given marker.

This allows to use "marker" to reject specific comments (in contrast to using --marker option to accept specific comments).

For example consider this code:

//~~ Constants ~~
const
  A = 1;
  B = 1;

{~~ Types ~~}
type
  T = T;

// This procedure does something.
//TODO: fix this
procedure DoSomething;

You can explicitly reject the unwanted comments above (used as region titles, or TODOs) by using PasDoc with

pasdoc --ignore-marker ~~ --ignore-marker TODO ...
PasDoc, documentation generator for Pascal:
Features:
Supported Tags:
Command Line:
Development:
Developers pages:
Clone this wiki locally
You can’t perform that action at this time.