Menu

using comma in a header

2006-08-24
2013-04-23
  • Toni Ronkko

    Toni Ronkko - 2006-08-24

    I noticed that in robodoc 4.99.26 commas are no longer accepted in headers, or at least they serve a different purpose now.  I have been using commas to separate overloaded C++ functions, and my documentation is no longer valid.  For example, I have C++ functions insert(id,atom), insert(id,bond) and insert(id,rotor) in a class and I cannot generate documentation anymore with these headers:

      /****f* molecule/molecule::insert(id,atom)
      /****f* molecule/molecule::insert(id,bond)
      /****f* molecule/molecule::insert(id,rotor)

    For the latter two cases robodoc 4.99.26 complains that: ``A header with the name "molecule/molecule::insert(id" already exists''. 

    I have been using robodoc a few years now and commas were allowed in previous versions.  For me, having commas in headers is a useful feature as I can document overloaded C++ functions with their true names.  Is there any change of getting the old behaviour back?

     
    • Frans Slothouber

      Hi,

      That's a clever use of the comma and ROBODoc.

      Will add an option to specify the string to seperate the functions in V4.99.30. 
      Then with:
         --function-list-seperator=","
      you will have the old behaviour back.

      Have fun,
      Frans.

       
    • Thuffir

      Thuffir - 2006-09-24
       

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.