Doxygen and GNU Cobol

GnuCOBOL
2014-07-24
2014-08-18
  • Brian Tiffin
    Brian Tiffin
    2014-07-24

    A reminder post.

    Full on, world class, auto generated COBOL documentation.

    Along with ROBODoc, http://opencobol.add1tocobol.com/gnucobol/#robodoc-support this will add another option for interactive HTML and LaTeX output forms.

     Edit these lines in your Doxyfile:
     FILE_PATTERNS = *.cob *.cpy 
     INPUT_FILTER = "sed -e 's|*><*|//!|'" 
     FILTER_SOURCE_FILES = YES 
    
     Add a brief description to the top of each file: 
     *><* Default brief description. 
     *><* @author COBOL coder
     *><* @file
    

    Woohoo. Doxygen and COBOL. Initial test worked, but will need to explore all the nifty options and what documentation tags are appropriate, especially for getting at call graphs.

    Cheers,
    Brian

     
    • Brian Tiffin
      Brian Tiffin
      2014-08-18

      Checked.

      Voting, fail. No woohoo, no call graphs, just sad. ;-)

      There are too many deltas in the source scanner, and it'll be heart breaking without building a full Doxygen lexer specific to COBOL. Not a small thing.

      The C output? Oh yeah, Doxygen is still the best, but not the COBOL. Not with shoehorns and duct tape, not even close. :-)

      Anyone wanting auto generated COBOL documentation, from within freebie land, ROBODoc may still be a best bet, or ocdoc, both requiring a little more effort.

      Cheers,
      Brian

       
      Last edit: Brian Tiffin 2014-08-18