V70f: Build docs requires imports to be prefixed

Monkey Forums/Monkey Bug Reports/V70f: Build docs requires imports to be prefixed

MikeHart

(Posted 2013) [#1]

Hi Mark,

in v70f, when using insource documentation, imports of sub modules need to be prefixed with the top module directory.

I have fantomEngine/fantomEngine.monkey which imports
other modules like this:

Import cftMisc
Import cftFunctions
Import cftImage
Import cftObject
Import cftLayer

MakeDocs complains like this:

fantomEngine : Can't find import module: cftMisc

But this works:

Import fantomEngine.cftMisc
Import fantomEngine.cftFunctions
Import fantomEngine.cftImage
Import fantomEngine.cftObject
Import fantomEngine.cftLayer

Kinda inconvenient and maybe a bug.

MikeHart

(Posted 2013) [#2]

Btw. how does someone flag parts of a file not being documented.

I can use Private and Public for fields but how do I manage internal classes, methods, functions, imports not being documented?

If I need that, is using a prebuild Monkeydoc file the only solution?

marksibly

(Posted 2013) [#3]

Will fix the import issue.

> Btw. how does someone flag parts of a file not being documented.

Just don't #Rem monkeydoc the bits you don't want docced.

[edit]Ok, that's not quite working either - will fix too[/edit]

Or, you could use #Rem monkeydoc_private if you still wanted source monkeydocs for your own reference.

marksibly

(Posted 2013) [#4]

Ok Fixed the import issue and have added:

#Rem mokeydoc off
#End

#Rem monkeydoc on
#End

To let you turn monkeydocs on/off. #Rem monkeydoc also turns docs on.

If monkeydocs are on, all decls are docced whether or not they have a #Rem monkeydoc or not.

MikeHart

(Posted 2013) [#5]

Thanks.