JabRef / jabref

Graphical Java application for managing BibTeX and biblatex (.bib) databases
https://devdocs.jabref.org
MIT License
3.64k stars 2.59k forks source link

[OO] Javadoc: Add `@implSpec` tags #12216

Open subhramit opened 4 days ago

subhramit commented 4 days ago

Recently I learnt about @implSpec tags which are used to specify requirements/preconditions for methods. This helped clean the documentation of my code a bit.

The tag shows up as "Implementation Requirements:" in javadoc as follows:

Screenshot (5)

Mandatory checks

subhramit commented 4 days ago

Thought: Like we have priority classifications for issues, should we have labels for PRs as well such as "non-blocking", "non-breaking", "non-urgent", "low priority", etc.?

calixtus commented 4 days ago

Some reading about this tag: https://nipafx.dev/javadoc-tags-apiNote-implSpec-implNote/