We're currently in very early stages (read: no work yet) of rebuilding 
our entire stable of interrelated websites to take advantage of MX 6.1 
and J2EE (we're currently using CF5 only).

The myriad exciting bits of a blank-slate project like this aside, 
there's one aspect of it (and maybe more in the future) I wanted to 
bounce off of CF-Talk.

We're looking at having structured XML documentation for our 
templates/CFC's, sort of like what you'd find in Fusebox/Mach-II.  I 
figure we can import a namespace for our documentation structure and 
reference it that way - and customize DWMX to make writing those tags easy.

Well, I figure that's only half of the way there.  We're also evaluating 
using an EJB layer to help structure and speed up our data access and 
move the bulk of our "business logic" to a single layer.  Now, due to 
the lovely Javadoc, we'd be able to have a terrific, browsable API once 
we're all done of methods and interfaces for that section.

My question (and I did have one!) is, has anyone written or come across 
a Javadoc-like "aggregator" for structured XML documentation - something 
that would produce a browsable API manual?  The basic method behind 
something seems fairly straightforward - have a spider move through the 
various templates and create an HTML file based off the found 
documentation tags.  Naturally, the planning is more complicated - you'd 
have to determine how to flag interrelated tags, denote parent/child 
relationships and the like, but I think the payoff for that would be 
fantastic, especially in regards to bringing someone new into the team - 
they'd have immediate access to easily readable, cogent documentaion 
that didn't consist of trying to follow a thousand <!--- ---> tags.  It 
sounds like something that would be a lot of fun to write.

Thoughts?  Warnings?  Screams of Pain?

- Jim

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|
Message: http://www.houseoffusion.com/lists.cfm?link=i:4:137600
Archives: http://www.houseoffusion.com/lists.cfm?link=t:4
Subscription: http://www.houseoffusion.com/lists.cfm?link=s:4
Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4

This list and all House of Fusion resources hosted by CFHosting.com. The place for 
dependable ColdFusion Hosting.
http://www.cfhosting.com

Reply via email to