A Few Questions Migrating From Natural Docs

[warhammerkid]

After much research I have decided to use jgrousedoc to document my
javascript project. However, I ran into a few issues migrating from
Natural Docs.

1. Is there a way to turn off sorting in the documentation, as the
order I have it in the code is the order I would like it to show up in
in the documentation?

2. Is there some kind of simplified syntax for documenting many class
constants in one go? Natural Docs allows something like this:
/**
* Static Properties: Events
*
* UI_READY - Dispatched one the page is loaded and ready to interact
with
* VIEW_CHANGED - Dispatched when gmonkey notifies us of a view change
*/
UI_READY: 'ui_ready',
VIEW_CHANGED: 'view_changed'

3. The private prefix doesn't seem to do anything, and I was wondering
if maybe I was doing something wrong, or whether it simply doesn't
work.

Sincerely,
Stephen

[denis.r...@gmail.com]

Hi Stephen,

With #1 and #2 - you're pretty much out of luck unless you want to
modify the source code.
#3 - should work. Check the setting of privatePrefix in
jgrousedoc.properties. The expected behavior is
that all identifiers that start with it will be treated as "private"
if it still does not work, pls publish your jgrousedoc.properties and
a sample file and I will check it.

Regards,
Denis

[warhammerkid]

Here is my jgrousedoc.properties file:
jGrouseHome.default=/usr/local/lib/jGrouseDoc/
inputDir.default=.
fileMask.default=**/*.js
outputDir.default=docs
projectName=GTD Gmail
privatePrefix=_

And here is the sample file:
/**
* Description
*
* @class ?
*/
var glRequest = glBase.extend({
/** @property ? The post data in a string */
_postString: null,
});

[denis.r...@gmail.com]

Aha!
Seems like privatePrefix setting does not work with placeholders, like
in your case @property ?
If you specify it like "@property _postString" it will work as
prescribed

I will add corresponding item to the bug list

Regards,
Denis

[denis.r...@gmail.com]

Stephen,

I have fixed the problem, the fix is available in SVN

Regards
Denis

[warhammerkid]

Denis,

Thanks so much. I really appreciate the quick fix.

Stephen