API Specification Errors
Errors in Interface: org.biojava.bio.symbol.CodonPrefFilter


Category 1: Interface Error

Interface CodonPrefFilter
  • Interface missing comment.
/**
 * Defines the requirements for an object that ...
 *
 * @author unattributed
 * @version %I% %G%
 */

Category 2: Member Error

CodonPrefFilter$AcceptAll
  • Class missing comment.
/**
 * 
 */
CodonPrefFilter$AcceptAll.getCodonPrefs()
  • Method missing comment, but reasonably self-evident.
/**
 * Returns the codon prefs value.
 */
CodonPrefFilter$ByName
  • Class missing comment.
/**
 * 
 */
CodonPrefFilter$ByName.CodonPrefFilter.ByName(String)
  • Constructor missing comment.
/**
 * Constructs a CodonPrefFilter$ByName object.
 *
 * @param name  a String ...
 */
CodonPrefFilter$ByName.getCodonPref()
  • Method missing comment, but reasonably self-evident.
/**
 * Returns the codon pref value.
 */
CodonPrefFilter$EverythingToXML
  • Class missing comment.
/**
 * 
 */
CodonPrefFilter$EverythingToXML.CodonPrefFilter.EverythingToXML(PrintWriter)
  • Constructor missing comment.
/**
 * Constructs a CodonPrefFilter$EverythingToXML object.
 *
 * @param pw  a PrintWriter object
 */
CodonPrefFilter$EverythingToXML.close()
  • Method missing comment.
/**
 *
 */

Category 3: Tag Error

isRequired(String)
  • Missing tag.
  • Missing @return tag.
 *
 * @param name  a String
 * @return true if ...
put(CodonPref)
  • Missing tag.
  • Missing @throws tag.
 *
 * @param codonPref  a CodonPref object
 * @throws BioException ...

Category 4: Text/Link Error

isRequired(String)
  • Html Error in First Sentence
    --Missing a period
indicates if the current CodonPref is to be accepted

put(CodonPref)
  • Html Error in First Sentence
    --Missing a period
handles storage of a CodonPref object

Explanation of Columns

Left Column
Identifies the error or warning.
Right Column
Shows the comment-text that generated the error in red.
Displays a template you can cut and paste in black.