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

Doclint #264

Merged
merged 25 commits into from Feb 11, 2017
Merged

Doclint #264

merged 25 commits into from Feb 11, 2017

Conversation

johnmay
Copy link
Member

@johnmay johnmay commented Jan 23, 2017

Work in progress on making the new JavaDoc Doclint happy.

@johnmay
Copy link
Member Author

johnmay commented Jan 23, 2017

Right all done, just powered through in the end:

Before:
1453 errors
1841 warnings

Now:
9 errors
1748 warnings

@johnmay
Copy link
Member Author

johnmay commented Jan 23, 2017

Correction... should be:

0 errors, mistyped key!

@johnmay
Copy link
Member Author

johnmay commented Feb 7, 2017

@egonw Are you okay for me to merge this in. Making some different changes ATM and realise it may cause a merge conflict.

@egonw
Copy link
Member

egonw commented Feb 7, 2017

Are you done then? I'll review it tonight or tomorrow morning... OK?

@johnmay
Copy link
Member Author

johnmay commented Feb 7, 2017

Yep all done

* and fused sets of cyclic atoms. The colored circles indicate the atoms and
* bonds that are returned for each molecules. <br/><br/> <img alt="isolated and
Copy link
Member

Choose a reason for hiding this comment

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

This was at some point because of browser compatibility...

* @cdk.keywords axial chirality
* @cdk.keyword extended tetrahedral
* @cdk.keyword allene
* @cdk.keyword axial chirality
Copy link
Member

Choose a reason for hiding this comment

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

nice catch :)

Copy link
Member Author

Choose a reason for hiding this comment

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

all in the error log :-)

@@ -65,7 +65,7 @@ public RebondTool(double maxCovalentRadius, double minBondDistance, double bondT
/**
* Rebonding using a Binary Space Partition Tree. Note, that any bonds
* defined will be deleted first. It assumes the unit of 3D space to
* be 1 &Acircle;ngstrom.
* be 1 Å.
Copy link
Member

Choose a reason for hiding this comment

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

👍

@@ -249,7 +249,7 @@
* @param <T> generic type (of provided class)
* @return the value stored for the specified description.
* @see #getProperty(Object)
* @see #addProperties(java.util.Map)
* @see #getProperties()
Copy link
Member

Choose a reason for hiding this comment

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

oh, that's actually the wrong "see"... this was following the "java beans" docs pattern: the getter method has a see to the setter method and visa versa. (not a big issue)

* so that the RMDS is minimized to the coordinates of the first array
* @param al1 An array of {@link IAtom} objects
* @param al2 An array of {@link IAtom} objects. This array will have its coordinates rotated
* so that the RMSD is minimized to the coordinates of the first array
Copy link
Member

Choose a reason for hiding this comment

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

Can Doclint do spell checking?

Copy link
Member Author

Choose a reason for hiding this comment

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

No I spotted that as I did it

* <table border="1">
* <caption>Table 1: Parameters set by this rule.</caption>
Copy link
Member

Choose a reason for hiding this comment

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

Very nice!

@egonw egonw merged commit b4ad53a into master Feb 11, 2017
@johnmay johnmay deleted the doclint branch February 12, 2017 21:54
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.

None yet

2 participants