Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an option for static items and function begining with "__". #11

Open
nrootconauto opened this issue Nov 19, 2020 · 2 comments
Open
Assignees
Labels
enhancement New feature or request priority-low
Milestone

Comments

@nrootconauto
Copy link

I love codedoc,im not a fan of gaint software so codedoc is 102% my favorite documentation generator. The problem is that i want to document "hidden" functions and such. Like i can have the main API in the header files,but also document the support functions in the c files. Can you add an option to document "hidden" functions and such. I am busy writing a compiler otherwise i would do it myself.

Thanks a lot btw,i love your mini-xml library too.

@michaelrsweet
Copy link
Owner

@nrootconauto I can probably add an option to include "private" declarations (starting with "_" or otherwise tagged with @private@) fairly easily since those are just excluded (but still parsed). Including static definitions would require a third level of scoping (public, private, local) and a little more work I think.

Are you wanting all of the documentation together, or do you want the private/static stuff split out for "internal developer" documentation?

@michaelrsweet michaelrsweet self-assigned this Nov 19, 2020
@michaelrsweet michaelrsweet added enhancement New feature or request priority-low labels Nov 19, 2020
@michaelrsweet michaelrsweet added this to the Future milestone Nov 19, 2020
@nrootconauto
Copy link
Author

nrootconauto commented Nov 19, 2020

If i was to do it myself,would you merge my changes in. I could also clean-up the C parser a bit

@nrootconauto I can probably add an option to include "private" declarations (starting with "_" or otherwise tagged with @private@) fairly easily since those are just excluded (but still parsed). Including static definitions would require a third level of scoping (public, private, local) and a little more work I think.

Are you wanting all of the documentation together, or do you want the private/static stuff split out for "internal developer" documentation?

Ok,ill do it. Im looking for a "internal developer" documentation type documentation generator. Thankfully the code is mainly in codedoc.c(Cant go wrong with that lol)

(Ill do it at night while i get tired,i have work to do)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority-low
Projects
None yet
Development

No branches or pull requests

2 participants