search

ideaconsult / jna-inchi

Wrapper to access InChI from Java
GNU Lesser General Public License v2.1
0 stars 0 forks source link

javadoc for FileTextUtils #9

Closed uli-f closed 1 year ago

uli-f commented 1 year ago

FileTextUtils might benefit from some javadoc, primarily on the class level and maybe also for some of the non trivial/longer methods on the method level.

In particular, a few options have default values (format, checkParityAccordingAtomNumbering, guessTetrahedralChiralityFromBondsInfo) and it might be worthwhile clearly communicating those default values in the javadocs.

This issue might be best worked on once #8 is completed.

ntk73 commented 1 year ago

I agree that this java doc would be beneficial. I will see for this as well.

ntk73 commented 1 year ago

I have added javadocs on class level. Option checkParityAccordingAtomNumbering is commented indirectly in the javadocs since, for now, this flag is not made visible (I felt it this way)

uli-f commented 1 year ago

Thanks for putting these in, makes it much clearer to me.