diff --git a/docs/manual/creating-a-checker.tex b/docs/manual/creating-a-checker.tex index 5867a31e7a9..5b06080f8a7 100644 --- a/docs/manual/creating-a-checker.tex +++ b/docs/manual/creating-a-checker.tex @@ -124,7 +124,7 @@ The Base Checker -(more precisely, the \refclass{framework/common/basetype}{BaseTypeChecker}) +(more precisely, the \refclass{common/basetype}{BaseTypeChecker}) enforces the standard subtyping rules. The Subtyping Checker is a simple use of the Base Checker that supports providing type qualifiers on the command line. @@ -951,7 +951,7 @@ A checker's entry point is a subclass of \refclass{framework/source}{SourceChecker}, and is usually a direct subclass -of either \refclass{framework/common/basetype}{BaseTypeChecker} or +of either \refclass{common/basetype}{BaseTypeChecker} or \refclass{framework/source}{AggregateChecker}. This entry point, which we call the checker class, serves two @@ -991,7 +991,7 @@ a type system named Foo, the compiler interface (checker), the visitor, and the annotated type factory are named as \, \, and \. -\refclass{framework/common/basetype}{BaseTypeChecker} uses the convention to +\refclass{common/basetype}{BaseTypeChecker} uses the convention to reflectively construct the components. Otherwise, the checker writer must specify the component classes for construction. @@ -1101,7 +1101,7 @@ MyChecker needs to use. Override -\ +\ to return a list of the checkers that MyChecker depends on. Every one of them will be run before MyChecker is run. One of MyChecker's subcheckers may itself be a compound checker, and multiple checkers may declare a @@ -1112,7 +1112,7 @@ it) by querying their \refclass{framework/type}{AnnotatedTypeFactory} to determine the types of variables. Obtain the \ by calling -\refmethodterse{framework/common/basetype}{BaseTypeChecker}{getTypeFactoryOfSubcheckerOrNull}{(java.lang.Class)}. +\refmethodterse{common/basetype}{BaseTypeChecker}{getTypeFactoryOfSubcheckerOrNull}{(java.lang.Class)}. An example of a compound checker is \refclass{checker/signedness}{SignednessChecker} @@ -1181,12 +1181,12 @@ \subsubsectionAndLabel{Default Options}{creating-providing-command-line-options-default-options} The default options passed to a custom checker may be customized by overriding the -\refmethodterse{framework/common/basetype}{BaseTypeChecker}{getOptions}{()} method in the +\refmethodterse{common/basetype}{BaseTypeChecker}{getOptions}{()} method in the custom checker class. For example, to ignore the \ warnings raised by the Optional Checker (Chapter~\ref{optional-checker}), override -\refmethodterse{framework/common/basetype}{BaseTypeChecker}{getOptions}{()} as follows: +\refmethodterse{common/basetype}{BaseTypeChecker}{getOptions}{()} as follows: \begin{Verbatim} @Override