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

bug(#209): XMIR links in Program, Programs, Defect JavaDoc #229

Merged
merged 1 commit into from
Jan 10, 2025
+14 −1
Merged

bug(#209): XMIR links in Program, Programs, Defect JavaDoc #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/main/java/org/eolang/lints/Defect.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,14 @@

/**
* A single defect found.
*
* Defect is a node in the XMIR under `/program/defects`, that describes the
* issue with EO/XMIR source code. Defect contain the message that addresses
* source code and points to the problem in it. Some defects report the problems
* on XMIR format itself, consider to check resources on XMIR in order to get
* understanding how intermediate representation of EO is structured in XML format.
* @see <a href="https://news.eolang.org/2022-11-25-xmir-guide.html">XMIR guide</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@h1alexbel read this: https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html

also, run mvn site -Psite and then open the files generated in target/site/javadoc/index.html You will see how your text is formatted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yegor256 getting this:
image

should be good I believe, or I missing something?

* @see <a href="https://www.eolang.org/XMIR.html">XMIR specification</a>
* @see <a href="https://www.eolang.org/XMIR.xsd">XMIR schema</a>
* @since 0.0.1
*/
public interface Defect {
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/eolang/lints/Program.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ public Program(final XML xml) {
/**
* Find defects possible defects in the XMIR file.
* @return All defects found
* @see <a href="https://news.eolang.org/2022-11-25-xmir-guide.html">XMIR guide</a>
* @see <a href="https://www.eolang.org/XMIR.html">XMIR specification</a>
* @see <a href="https://www.eolang.org/XMIR.xsd">XMIR schema</a>
*/
public Collection<Defect> defects() {
try {
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/eolang/lints/Programs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ public Programs(final Map<String, XML> map) {
/**
* Find defects possible defects in the XMIR file.
* @return All defects found
* @see <a href="https://news.eolang.org/2022-11-25-xmir-guide.html">XMIR guide</a>
* @see <a href="https://www.eolang.org/XMIR.html">XMIR specification</a>
* @see <a href="https://www.eolang.org/XMIR.xsd">XMIR schema</a>
*/
public Collection<Defect> defects() {
final Collection<Defect> messages = new LinkedList<>();
Expand Down
Loading