Skip to main content
Participant
January 17, 2009
Question

UDF/CFC Documentation

  • January 17, 2009
  • 1 reply
  • 306 views
Hello, I am looking for a nice tool to read the comments in my UDF's and CFC's in order to build a nice documentation. I have found several tools but they either only work for CFC's or generate a static HTML page. (for example: http://www.coldfusionjedi.com/index.cfm/2008/12/11/Ask-the-Crowd-Documentation). I need a function or custom tag that generates variables for the documentation as I need to save the documentation in a database. I do not need static HTML files. I read something about UDFDoc. But I cannot find a download page. Has anybody any idea or solution.
Thanks a lot for your help. Andy
    This topic has been closed for replies.

    1 reply

    Inspiring
    January 17, 2009
    > Hello, I am looking for a nice tool to read the comments in my UDF's and CFC's
    > in order to build a nice documentation. I have found several tools but they
    > either only work for CFC's or generate a static HTML page. (for example:
    > http://www.coldfusionjedi.com/index.cfm/2008/12/11/Ask-the-Crowd-Documentation).
    > I need a function or custom tag that generates variables

    Come, use your nous.

    All those options Ray mentions are open source, so go grab one/each of
    them, *look at the code* at modify it to suit your needs.

    There's not much difference between "writing to static HTML" and "writing
    to DB". It's just the last step in the process that would need to change a
    bit.

    --
    Adam
    BontheAuthor
    Participant
    January 18, 2009
    Hi, that is what I finally did. I grabbed the code and picked out some parts I need. My problem was or is that I do not fully understand Regular Expressions - at least the syntax - and therefore is was difficult to amend the code to the requests I have. Yesterday evening I found a solution for my problem now. Thanks for you feedback anyway. Andy