Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added javadoc to IChemObjectReader explaining the split between ISimp…
…le and IIterating ChemObjectReaders Signed-off-by: Rajarshi Guha <rajarshi.guha@gmail.com>
- Loading branch information
Showing
1 changed file
with
9 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,12 +28,19 @@ | |
import org.openscience.cdk.exception.CDKException; | ||
|
||
/** | ||
* This class is the interface that all IO readers should implement. | ||
* | ||
* This interface specifies the common functionality all IO readers should provide. | ||
* | ||
* IO readers should not implement this interface directly, but rather implement | ||
This comment has been minimized.
Sorry, something went wrong. |
||
* one of its child interfaces: {@link ISimpleChemObjectReader} or {@link org.openscience.cdk.io.iterator.IIteratingChemObjectReader}. | ||
* These sub-interfaces specify the information access methods: | ||
* a simple read() method for the {@link ISimpleChemObjectReader} and | ||
* more advanced iterator based access for the {@link org.openscience.cdk.io.iterator.IIteratingChemObjectReader} (suitable for large files) | ||
* | ||
This comment has been minimized.
Sorry, something went wrong.
egonw
Member
|
||
* @cdk.module io | ||
* @cdk.githash | ||
* | ||
* @author Egon Willighagen <egonw@users.sf.net> | ||
* @see ISimpleChemObjectReader, org.openscience.cdk.io.iterator.IIteratingChemObjectReader | ||
**/ | ||
public interface IChemObjectReader extends IChemObjectIO { | ||
|
||
|
If you want the new paragraph to show up in the JavaDoc HTML too, you need to start with
...