search

JakubAndrysek / MkDoxy

📖 Automatically generates API documentation for your project based on Doxygen comments and code snippets in your markdown files.
https://mkdoxy.kubaandrysek.cz/
MIT License
60 stars 16 forks source link

What is policy for contributions? #55

Closed kamorrissey closed 11 months ago

kamorrissey commented 1 year ago

What is your policy for contributing? I would like to expand src-dirs: in mkdocs.yml config to accept glob patterns, including recursive. Would you mind adding a CONTRIBUTING.md?

JakubAndrysek commented 1 year ago

Thank you for your request. I'm trying to figure out what do you want to change. src-dirs accept any string that you want. This input is directly passed into Doxygen INPUT parameter. Together with RECURSIVE = YES is possible to input multiple directories. Then using the FILE_PATTERNS = *.c *.cpp *.h argument is possible to limit including files.

I'm working on better documentation that will include this necessary information for future developers.

I didn't have CONTRIBUTING.md right now, but I will add it in the nearest future. I am new to open-source contributions. If you have some recommendations on how to improve this project, please let me know.

kamorrissey commented 1 year ago

We have a case where we would like to use the line like

src-dirs: 'src//include/public src//include/unpublished'

to yield over a dozen directories instead of manually listing them.

sent from my mobile device Karen A Morrissey Author, Fisher King: Percival's Descent @.*** karenamorrissey.blogspot.com 720-308-4368 mobile

On Thu, May 4, 2023, 2:24 AM Kuba Andrýsek @.***> wrote:

Thank you for your request. I'm trying to figure out what do you want to change. src-dirs accept any string that you want. This input is directly passed into Doxygen INPUT parameter. Together with RECURSIVE = YES is possible to input multiple directories. Then using the FILE_PATTERNS = .c .cpp *.h argument is possible to limit including files.

I'm working on better documentation that will include this necessary information for future developers.

I didn't have CONTRIBUTING.md right now, but I will add it in the nearest future. I am new to open-source contributions. If you have some recommendations on how to improve this project, please let me know.

— Reply to this email directly, view it on GitHub https://github.com/JakubAndrysek/MkDoxy/issues/55#issuecomment-1534283945, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA2RDH5PYSBRWSGETW3VXGDXENRU3ANCNFSM6AAAAAAXUZMV6Q . You are receiving this because you authored the thread.Message ID: @.***>