Generate documentation for a particular file region only #1949

Closed Answered by echasnovski

A7Lavinraj asked this question in Q&A

A7Lavinraj
Aug 17, 2025

Contributing guidelines

I have read CODE_OF_CONDUCT.md

Module(s)

mini.doc

Question

@echasnovski Hey can mini.doc can generate documentation for the content which is only inside the @brief tags and leave other type annotations.

Answered by echasnovski

Hi!

The answer is "probably, yes", but it is not really designed to do so. Depending on the use case, I'd suggest:

Adding ---@private to any section that you don't want 'mini.doc' to touch.
Adjust all/necessary hooks to do nothing.

View full answer

Replies: 1 comment

echasnovski
Aug 17, 2025
Maintainer

Hi!

The answer is "probably, yes", but it is not really designed to do so. Depending on the use case, I'd suggest:

Adding ---@private to any section that you don't want 'mini.doc' to touch.
Adjust all/necessary hooks to do nothing.

0 replies

Answer selected by echasnovski

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment