Menu

creating html using naturaldocs for xml files

Dileep
2013-12-30
2013-12-31
  • Dileep

    Dileep - 2013-12-30

    Hi,
    Please find the attached xml file. I am trying to produce HTML for this file using Natural Docs.
    Is it possible to produce HTML for it using naturaldocs?

    I have added "command" as topic in Topics.txt file as shown in below

    Topic Type: Command
    Plural: Commands
    Keywords:
    command, commands
    example, examples
    description, descriptions
    parameter, parameters
    type, types
    name, names
    return, returns

    I have added "XML" as language as shown in below

    Language: Xml
    Extension: xml
    Line Comment: <

    Natural Docs didn't produce anything after running the code.
    Can you please help me to produce HTML for this xml file?

     

    Last edit: Dileep 2013-12-30
  • Greg Valure

    Greg Valure - 2013-12-30

    No, Natural Docs can't extract documentation from an arbitrary XML format. You'd have to write documentation in its own format which is described here:

    http://www.naturaldocs.org/documenting.html

    It would look something like this:

    /* Command: write_por
    
       This command is used to configure a port.
    
       Example:
    
          > write_por("B", "DDR", "0xD")
    
       Parameters:
    
          port - Choosess ...
    
       Returns:
    
          outputdata - the RX buffer's content
    */
    ... code for write_por ...
    
     

    Last edit: Greg Valure 2013-12-30
  • Dileep

    Dileep - 2013-12-31

    Thank you very much for the info.

     

    Last edit: Dileep 2013-12-31

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.