Menu

#8 Feature requests 3175990, 3175992, 3175997

xsddoc-1.0
open
5
2011-03-04
2011-02-15
No

Dear xsddoc admins/maintainers,

I patched xsddoc version 1.-0 to accomodate my above mentioned feature requests and kindly ask that you integrate the patch into xsddoc.

- Improved command line error handling
- Errors cause xsddoc to exit with code 1
- New command line argument -n|-neDoc sets nested element documentation mode to short, full or full/preformatted text
- Ability to specify and document multiple XML schema documents on the command line

While you are at it, please change the line terminators in the UNIX shell script bin/xssdoc from Windows to UNIX format. (The script won't work with Windows line terminators)

Also can you make a release 1.1 or 1.0.1 ?

If you don't have the time to do all this , I'd be happy to help out if you give me the appropriate rights (I have own SF projects so I know what to do).

thank you
Chris

Discussion

  • Kurt Riede

    Kurt Riede - 2011-03-04

    Hello Chris,

    thank you for your patch. Please provide a patch in the unified format that the Eclipse can Apply Patch Wizzard accepts?
    I will the check-in your changes.

    Thank you,
    Kurt

     
  • Kurt Riede

    Kurt Riede - 2011-03-04
    • assigned_to: nobody --> kriede
     
  • Christoph Schwarz

     
  • Christoph Schwarz

    Hello Kurt,

    I uploaded the patch in unified format and also added a patch that removes DOS line feeds from the xsddoc shell script.

    Thanks for taking time. Will there be an official release of these (and possibly other) changes?

    thanks, Chris

     
  • Kurt Riede

    Kurt Riede - 2011-03-08

    Hi Chris,

    your patch is now applied on my desktop, but not yet checked-in to CVS.

    I like your on-the fly generation of a mediator schema for collecting multiple schema files.

    Concerning the handling of nested element documentaion, I am wondering if we should offer this in general, or at least a part your changes. Here are my sugestions

    (1) pre-tags: I would suggest a new parameter that is used for ALL documentation, similar to the -noasciiart parameter in xnsdoc (http://www.buldocs.com/xnsdoc/usage.html)

    (2) short or long: I would suggest a new paramter -(e.g. -longDoc) that is used for all documentation that is currently transformed in short-documentation mode.

    (3) Apache Ant: I will take care of enabeling all new features in the Ant task. For the multiple schema file feature I hopefully can adopt some code from xnsdoc.

    Please let me know if you agree with my suggestions or if you have different or further ideas.

    Thank you
    Kurt

     
  • Kurt Riede

    Kurt Riede - 2011-03-08

    Hello Chris,

    one further note:
    The Ant task already has a handling for documenting multiple schema files. This approach uses the DOM API to build the mediator schema, so I suggest to move this handling to the processor, such that the console interface can also use it instead of your StringBuilder based approach.
    Any comments?

     
  • Christoph Schwarz

    Hi Kurt,

    if the multiple xsd feature already exists in the ant task use that code. I didn't look at the ant code. I don't mind my code being thrown away as long as this feature gets implemented :)

    Using pre-tags with all documentation is fine with me too. I found it is already used in element documentation, didn't spend too much time to make it consistent.

    short or long: I do not understand why one would only want a part of the documentation (== 1st sentence) appear in the HTML. That makes IMHO only sense when it is used in a summary with a link to the long version. But xsddoc does not generate doc like this. Or am I missing something here?

    Chris

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.