Doxygen equivalent for Mathematica?

Question

How to add additional information to a Mathematica package file, for example

• parameter
• doctests / usage example?

So far, I have only found the use line :: some information on how to write documentation notebooks. I'm looking for the opportunity to generate these documentation notebooks from an introspection of package files.

Answer 1

I do not know that there is any mechanism like doxygen built into math. If you want to embed the documentation notepad in your package, I would do the following:

• Record a notebook of documentation
• Insert the laptop as a character string in your package
• Write a help function that, when called, splits the file, writes a notepad, and uses interface manipulations to open it.

You might be able to skip creating an external laptop using Notebook [] instead of a character string to store documentation inside your package file.

Integration with Mathematica's own help system is a bit more complicated (as the link explains). Of course, you can still write the package and move the corresponding files into place when you download the package.