xjDocs - a code documentation generator for Xojo

  1. ‹ Older
  2. 4 years ago

    Paul M

    15 Feb 2014 Pre-Release Testers, Xojo Pro

    @Eric S I basically did exactly what you described, messed with the CSS, and managed to get the MMD tables to look mostly like your Constants table

    I just realized I did this already for MMD tables in other places, just not down in methods - I should fix that too...

  3. Paul M

    6 Mar 2014 Pre-Release Testers, Xojo Pro

    @Tim J Since I'm a C / C++ programmer for the bulk of my coding efforts, I use the "//[SPACE]" comment option. Could you update the project to support "// [" as the delimiter as well?

    For the next version, I have made it more flexible - you can start with either ' or // and have spacing in between, for example anything like these:

    ']
    ' ]
    //]
    // ]
    //              ]

    (OK, maybe the last one is extreme…)

  4. Dirk C

    7 Mar 2014 Pre-Release Testers, Xojo Pro Belgium, Zedelgem

    Windows Installer coming soon :)

  5. Emile S

    7 Mar 2014 Europe (France, Strasbourg)

    @Paul M For the next version, I have made it more flexible - you can start with either ' or // and have spacing in between, for example anything like these:

    ']
    ' ]
    //]
    // ]
    //              ]

    (OK, maybe the last one is extreme…)

    WARNING:

    Xojo trim pastes: if you paste "// ", Xojo just writes "//" in the IDE (without the quotes, of course).

  6. Paul M

    7 Mar 2014 Pre-Release Testers, Xojo Pro

    @Dirk C Windows Installer coming soon

    I'm hoping to have Windows and Linux builds in the next release (soon) - basic functionality seems ok, but they may be more rough around the edges than the Mac version...

  7. Paul M

    8 Mar 2014 Pre-Release Testers, Xojo Pro

    Version 2.0a2 is now ready.

    Highlights:

    • parameter and return value marking
    • more flexible comment marking
    • Windows and Linux versions

    http://www.parkbenchsoftware.com/xjDocs/

  8. Dirk C

    10 Mar 2014 Pre-Release Testers, Xojo Pro Belgium, Zedelgem

    Downloaded.
    Will test as soon as I have a bit of time.
    Thank you.

  9. Robin L

    10 Mar 2014 Xojo Inc Europe (Germany, Rehlingen)

    Looks good.
    Would really like to see a fully user configurable magic comment marker.
    My own document generator uses '///' :)
    And "NO!" it will never be released into the wild - it's way too personalised to my way of doing things :P
    Besides which it's largely written in SED and AWK, with a bit of Perl thrown in for good measure.

  10. Paul M

    10 Mar 2014 Pre-Release Testers, Xojo Pro

    @Robin L-Mitchell Would really like to see a fully user configurable magic comment marker.

    I went back and forth with the idea of making it configurable, and at one point it was. What concerned me, and maybe I was over thinking it, was that if multiple people were sharing code, and all used their own marker, then documenting the shared code wouldn't work. But would you be documenting other people's code? If you were, couldn't you agree on a marker? But what if you already had a lot of your own code marked your way? What if you used some of the same code, shared with different people who all used different markers? (See what I mean by over thinking?)

  11. Robin L

    10 Mar 2014 Xojo Inc Europe (Germany, Rehlingen)

    Sure :)
    I have seen teams use three documentation 'markers'; Personal, Team and Project. Only the Project marker was intended for resolving by an automated documentation system. Of course people would forget to change markers, or use the wrong one. But that is no worse than checking in multiple fixes in one shot, or forgetting to comment check-ins at all!

  12. Paul M

    10 Mar 2014 Pre-Release Testers, Xojo Pro

    But seriously, if a custom marker is desirable, I will consider it (with the setting being on a project by project basis).

    The question is, would people want to override the existing options and use only their own custom marker, or use the built in ones in addition to a custom one?

  13. Robin L

    10 Mar 2014 Xojo Inc Europe (Germany, Rehlingen)

    Custom marker/s in addition to the built-in set.

  14. 3 years ago

    Thanks for this application Paul, it's helped me out a great deal. Not sure if this is already known, but if xjd_Info is contained within a Folder it does not get parsed and does not work as expected.

    Great app!

  15. Emile S

    3 May 2015 Europe (France, Strasbourg)

    @Paul M But seriously, if a custom marker is desirable, I will consider it (with the setting being on a project by project basis).

    The question is, would people want to override the existing options and use only their own custom marker, or use the built in ones in addition to a custom one?

    Check all markers used in the project ?
    Will this be so much code / trouble ?

  16. Paul M

    5 May 2015 Pre-Release Testers, Xojo Pro

    @CharlieMcCormack Not sure if this is already known, but if xjd_Info is contained within a Folder it does not get parsed and does not work as expected.

    I believe that was intentional - so that there was only one, and we knew exactly where it was. If that causes issues, we can rethink the decision.

  17. Paul M

    5 May 2015 Pre-Release Testers, Xojo Pro

    @Emile S Check all markers used in the project ?
    Will this be so much code / trouble ?

    I think we will end up going this way for maximum flexibility.

    (It will be up to the people that use it and work together to agree on standards.)

  18. @Paul M I believe that was intentional - so that there was only one, and we knew exactly where it was. If that causes issues, we can rethink the decision.

    Yep, that makes sense!

  19. Paul M

    16 May 2015 Pre-Release Testers, Xojo Pro

    Just updated to 2.0a5 - now with better project processing error details and ability to continue even with problems.

  20. 2 years ago

    Paul M

    14 Jun 2016 Pre-Release Testers, Xojo Pro

    Update:

    Yes, it has been over a year with no new version - currently this project is on the back burner, but not abandoned. I have other big projects (plus a day job) keeping me busy.

    If anyone has problems with the current version, I will attempt to make time for fixes.

    Feel free to post any bug reports with our ticketing system:

    https://support.parkbenchsoftware.com/

  21. 7 days ago

    Dirk C

    Apr 13 Pre-Release Testers, Xojo Pro Belgium, Zedelgem

    Finally got around to sending you an email with 2 bugs
    I attached a demo project showing the bugs to the e-mail.

    • Markdown does not seem to get processed on Windows
    • Tables after the details section have a wrongly highlighted first line. (can be fixed by manually editing the css file)

    Let me know if you didn't receive my mail.

    Hope to see you at XDC.

or Sign Up to reply!