Author Topic: Document templates for methods with parameter notes  (Read 256 times)

bknoth2

  • EA User
  • **
  • Posts: 31
  • Karma: +0/-0
    • View Profile
Document templates for methods with parameter notes
« on: July 18, 2017, 05:46:51 am »
Any insights on how to create a template that generates documentation for a method that looks like the strcat sample below? Specifically, I want to know how to put the parameter types and names into the function signature and put a list of the parameters and their associated notes below the signature.

Thanks in advance for assistance
Bruce

---------------------------------------------------------------------------

char * strcat ( char * destination, const char * source );

destination
    Pointer to the destination array, which should contain a C string, and be large enough to contain the concatenated resulting string.
source
    C string to be appended. This should not overlap destination.


Ian Mitchell

  • EA User
  • **
  • Posts: 237
  • Karma: +2/-0
    • View Profile
Re: Document templates for methods with parameter notes
« Reply #1 on: July 21, 2017, 12:42:40 am »
Disclosure - I'm the author of eaDocX.
I've never tried it specifically with Parameters, but eaDocX will let you write an EA script which acts as a mini-generator, so you can format stuff in whatever styles you want. Maybe worth a try. Free trial so you can test it.

Ian Mitchell, Designer, eaDocX

www.eaDocX.com
www.theartfulmodeller.com