gollum icon indicating copy to clipboard operation
gollum copied to clipboard

Support configuration struct tags in the documentation generator

Open ppar opened this issue 7 years ago • 0 comments

The documentation generator at ./docs/generator/ could support the config struct tags introduced in https://github.com/trivago/gollum/pull/143 to:

  • Detect undocumented configuration parameters and include them in the documentation
  • Detetect and warn about inexistent / mistyped configuration parameters found in the doc comments

Not a very urgent need, but perhaps useful when revising documentation in the future.

ppar avatar Jun 16 '17 12:06 ppar