Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Configure comment style, or suppress the * per line. #302

Closed
ralfbiedert opened this issue Mar 20, 2019 · 2 comments
Closed

Configure comment style, or suppress the * per line. #302

ralfbiedert opened this issue Mar 20, 2019 · 2 comments

Comments

@ralfbiedert
Copy link
Contributor

For C projects, documentation is currently generated like this:

  /**
   * Result of f() 
   */
  my_ray combined;

In our project we feed the generated header into other tools, which then generate HTML. However, the * each line mess up the output format and require manual cleanup each time we regenerate.

It would be nice to configure the comment style, e.g., being able to select:

  • The current style
  • // each line
  • Only a /* at the start and an */ in the end.
@ralfbiedert ralfbiedert mentioned this issue Mar 23, 2019
Merged
emilio pushed a commit that referenced this issue Mar 24, 2019
@ralfbiedert @emilio
Add more documentation style options (#305)
51aff0a 
* Ignoring IDE files.

* Addresses issue #302, also amends #59 insofar that vanilla C-style now does not prefix individual lines with `*` anymore.

* Removed Javadoc reference.

* Renamed `Doxylight` to `Doxy` and changed C default to that.

* Added documentation.

* Changed enum name and applied `fmt`.

* Fixed comment.

* Fixed match.
@eqrion
Copy link
Collaborator

eqrion commented Mar 26, 2019

@emilio Can this be closed now?

@emilio
Copy link
Collaborator

emilio commented Mar 26, 2019

Yes. Fixed by #305.

@emilio emilio closed this as completed Mar 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ralfbiedert @emilio @eqrion