Skip to content

Fix JavaDocs (and enable PlantUML) #10244

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

Closed
wants to merge 4 commits into from

Conversation

koppor
Copy link
Member

@koppor koppor commented Aug 30, 2023

First attempt to check for JavaDoc validity.

Adds PlantUML-taglet to enable PlantUML in JavaDoc. There is MermaidJS support for JavaDoc, thus I opted for PlantUML.

IntelliJ will eventualle get support for PlantUML as well: https://youtrack.jetbrains.com/issue/IDEA-315387 - please vote up

Mandatory checks

  • Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@Siedlerchr
Copy link
Member

Not happy to havef syntax diagrams in javadoic

@koppor
Copy link
Member Author

koppor commented Aug 30, 2023

Wrong repository. Should have gone to @koppor

@koppor koppor closed this Aug 30, 2023
@koppor
Copy link
Member Author

koppor commented Aug 30, 2023

Follow-up: #10253

@koppor koppor deleted the enable-plantuml-in-javadoc branch August 30, 2023 23:17
@koppor koppor mentioned this pull request Aug 30, 2023
6 tasks
@koppor
Copy link
Member Author

koppor commented Sep 7, 2024

Discussion: Documentation should more go into the DevDocs. These could be linked from the JavaDoc.

We will include OpenFastTrace at #11710

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