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.

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

Update the JavaDoc generation #308

Closed
wants to merge 2 commits into from

Conversation

TheMrMilchmann
Copy link
Collaborator

With this PR...

  • more reliable @see and @since tag generation is added,
  • JavaDoc lines will always begin with a star ("*"). (Note that this does include code blocks!), and
  • less blank JavaDoc will be generated.

The changes have been made in order to enhance the readability and quality of generated documentation. However, this does come at the cost that code snippets may not be copied straight from code blocks any longer (what I consider bad practice anyways).

All differences in the generated code can seen here.

This also fixes a bug that sometimes caused @since tags to not be generated properly (current vs. updated).

(A piece of documentation on how commits should be titled would be nice. I hope that this is in compliance with the new format.)

- Added further support for "see" and "since" tags
- Fixed a bug that sometimes caused "since" tags to not be generated
@Spasi
Copy link
Member

Spasi commented May 15, 2017

Good job @TheMrMilchmann, we needed these fixes.

This PR has been merged manually with 2dbfac3, c3e5ea3 and ec09a19. There are a couple more cases fixed and the code is closer to the original implementation, for performance reasons. It's still not as efficient as I'd like, but it's hard to do the necessary refactoring (NativeClass::convertDocumentation is the blocker).

A piece of documentation on how commits should be titled would be nice.

I'm currently evaluating Conventional Commits (with Angular convention's flexibility) in LWJGL and some other projects. Not going to use the SemVer automation, but I think it's a useful convention. Especially in LWJGL with the dozens of bindings, it makes it easier to quickly identify what each commit is about.

I'll post some guidelines if/when I make the decision to adopt it.

@Spasi Spasi closed this May 15, 2017
@TheMrMilchmann TheMrMilchmann deleted the javadoc-gen branch May 15, 2017 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants