Why doesn't pub.win32 show up in help?
BlitzMax Forums/BlitzMax Programming/Why doesn't pub.win32 show up in help?
| ||
| Out of curiosity, how does BlitzMax determine which modules it should build documentation for and which ones it shouldn't? |
| ||
| Because it's not documented? |
| ||
| . |
| ||
| What I want to now is what triggers building the docs. Is there a file somehwere which says which modules to build docs for? Or does it simply look in the source files for some command that triggers it? And does it build documentation only for those source files in a module which contain said command, or do all get documentation if any have the command? And if it is a command, what command is it? Is it: Rem bbdoc: Audio/Audio playback End Rem The bbdoc command that triggers it? Or maybe... ModuleInfo "Version: 1.07" The moduleinfo command? Or both? |
| ||
| You will need a Rem/bbdoc:/End Rem block directly above each "node" you want to generate documentation for. It works in a cascading fashion... So, for example, to generate docs for a method within a type, you will need to have comment blocks on these : * Module * Type * Method For an imported file, to see any docs inside it, the main module file will require a comment block on Module. There are lots of examples. See Pub.Zlib for one. |
   |