C++ Code Generation Documentation Style.

UML related questions and discussions

Moderator: Moderators

C++ Code Generation Documentation Style.

Postby jim.beskar@rockwellcollins.com » Mon Jul 23, 2018 1:43 pm

When generating C++ code from a classes I hit a road block since i can not figure out how to create or modify the "Documentation Styles" which are available from Options->Project Options -> COde Engineering -> C++ Language Options ( see below). From what I can tell there are only 4 styles and you have to select one of these, there is not an option to create your own or modify an existing style.
I did play with changing the "Header", but I would like to modify the format of all the documentation/comments which are generated from the UML class diagram.

So is there a way to modify a code generation Documentation Style or create you own?

Thanks Much, Jim Beskar
jim.beskar@rockwellcollins.com
Forum Newbie
Forum Newbie
 
Posts: 2
Posts Rating:0
Joined: Mon Jul 23, 2018 1:40 pm

Re: C++ Code Generation Documentation Style.

Postby lisacarter19794@gmail.com » Fri May 21, 2021 12:14 am

I've personally never seen useful Doxygen/Javadoc style documents. In practice you just get an index of public function names, which is already in the source, so what's the point. If the function and argument names aren't obvious enough or there are caveats, add a comment to the declaration in the header.
lisacarter19794@gmail.com
Forum Newbie
Forum Newbie
 
Posts: 2
Posts Rating:0
Joined: Fri May 21, 2021 12:13 am

Re: C++ Code Generation Documentation Style.

Postby schroedermckenzie951176@gmail.com » Fri Jun 25, 2021 1:14 am

I have the same question as you!














word unscrambler
schroedermckenzie951176@gmail.com
Forum Newbie
Forum Newbie
 
Posts: 1
Posts Rating:0
Joined: Fri Jun 25, 2021 1:10 am


Return to Software Modeling (UML)

Who is online

Users browsing this forum: No registered users and 1 guest

cron