Does Synopsis recognize "outlined" comments?
Richard Kelly <[email protected]>
| Newsgroups | gmane.comp.documentation.synopsis |
|---|---|
| Organization | Jet Propulsion Laboratory |
| Message-ID | <[email protected]> |
We would very much like to use Synopsis here, but AFAIK Synopsis won't recognize "outlined" comments for class members. That's a problem for us, since the great majority of our code base uses "outlined", as opposed to "inlined", member function documentation. For example, in your Path.h example, Synopsis picks up the comment for Path::draw(), because the comment is inlined, i.e. right next to the member function declaration. However, if I write an outlined function *definition* and put the comment right next to that definition, then Synopsis doesn't pick it up. Does Synopsis currently have the ability to recognize outlined member function definitions and associate their comments with the corresponding member function declaration? If so, could you please point me to that feature? If not, is that something that could be added to Synopsis with modest effort? Depending on how big a job it would be, I might be willing to do it. If you like, I can file this as a bug report. Also, my example is pretty simple, but please let me know if you want to see my modified Path.h file. Thank you, Rick -- Richard M Kelly [email protected] [PGP => D5 C3 CC D2 B7 D0 A9 B0 D5 90 B2 55 5A 80 23 B6 FC AB 67 B4]