Generate documentation from coldbox handler/actions

Communities ColdBox HMVC
1

Hi y'all,

I just thought, while im cooking, that it would be good if i could
generate a map/documentation of the handlers/actions/views.

Just finding setNextEvents and setViews in the handler cfc's would do
it for the actions that just go to one view or nextevent.

If an action can go to multiple views or nextevents dan could parse
the if's and switches and display the cfcase value or the if-
expression in the documentation..

What do you guys think?

greets,
klaas

2

I think it is a great idea!! You can build a documentation module for this, how cool could that be, just drop it and boom it documents your app.

Luis F. Majano
President
Ortus Solutions, Corp

ColdBox Platform: http://www.coldbox.org
Linked In: http://www.linkedin.com/pub/3/731/483
Blog: http://www.luismajano.com
IECFUG Manager: http://www.iecfug.com

3

Cool, it would be really helpful in my case, because i have to hand-over my code to other developers in a later stage…

What do you mean by ‘module’?

gr,
klaas

4

http://wiki.coldbox.org/wiki/Modules.cfm
Luis F. Majano
President
Ortus Solutions, Corp

ColdBox Platform: http://www.coldbox.org
Linked In: http://www.linkedin.com/pub/3/731/483
Blog: http://www.luismajano.com
IECFUG Manager: http://www.iecfug.com

5

[swear word], since which version do they exist, this module system. I wish i had known about it earlier, i now always divide my handler dir into folders, just like my view dir, but i could have done this easier with modules…

Is this easy to integrate with reactor?

The best use i could think of for me, is that i have parts of my model that almost always are there, like the general lookup tables: currency,locale,language,country,region, user,userrole etc. And the authentication handler with it. Would it be easy to have a this part of the model in a module (called BaseApplication or something)?

I probably would get into trouble when i have a the other part of the model in another module. Reactor couldnt use multiple xml and model directories this way (if the records/gateways are linked)…

Ok, this is a total different subject in the meanwhile…

greets,
klaas

6

I Mean to say, if i make an applications with products for example, the product needs currency from the BaseApplication model.

7

Modules have been around for about 3 weeks, so you aren't exactly late
to the party or anything, no worries. I'm excited about using them.

Judah

8

thank god im not late to the party