btzy/nativefiledialog-extended

Doxygen

ds5678 opened this issue · 6 comments

ds5678 commented

After #118 is merged, I want to convert the existing comments to Doxygen syntax. That will enable other parsers (such as CppSharp) to pick up the documentation and use it in their own code generation. Is that ok with you?

btzy commented

I'm happy to accept a PR for this. The current comment syntax was mostly inherited from https://github.com/mlabbe/nativefiledialog and I agree it is kinda unusual.

ds5678 commented

Can the max character count be increased? That would make it easier for me to format lines correctly.

ds5678 commented

It is currently set to 100. 125 would be sufficient to format the lines.

btzy commented

Hmm, I was under the impression that Doxygen will only generate a line/paragraph break if you leave at least one blank line in code.

For example:

/**
 * Blah1
 * Blah2
 */

... generates

Blah1 Blah2

and

/**
 * Blah1
 *
 * Blah2
 */

... generates

Blah1

Blah2

ds5678 commented

They were getting parsed as individual paragraphs by CppSharp, but that could just be an implementation issue on their end. I will investigate with Doxygen directly.

  • 👍1
btzy commented

Evidence on the internet concurs with me: https://stackoverflow.com/questions/20508669/how-to-set-multiple-lines-in-a-doxygen-paragraph

There might be some flag you can set on the CppSharp documentation parser to make it behave like Doxygen.

  • 👍1