Skip to content

Commit

Permalink
Fix links.
Browse files Browse the repository at this point in the history
  • Loading branch information
smillst committed Oct 2, 2024
1 parent dda798d commit 33dfb84
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
22 changes: 11 additions & 11 deletions docs/manual/creating-a-checker.tex
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@


The Base Checker
(more precisely, the \refclass{common/basetype}{BaseTypeChecker})
(more precisely, the \refclass{framework/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.
Expand Down Expand Up @@ -953,7 +953,7 @@

A checker's entry point is a subclass of
\refclass{framework/source}{SourceChecker}, and is usually a direct subclass
of either \refclass{common/basetype}{BaseTypeChecker} or
of either \refclass{framework/common/basetype}{BaseTypeChecker} or
\refclass{framework/source}{AggregateChecker}.
This entry
point, which we call the checker class, serves two
Expand Down Expand Up @@ -993,7 +993,7 @@
a type system named Foo, the compiler
interface (checker), the visitor, and the annotated type factory are
named as \<FooChecker>, \<FooVisitor>, and \<FooAnnotatedTypeFactory>.
\refclass{common/basetype}{BaseTypeChecker} uses the convention to
\refclass{framework/common/basetype}{BaseTypeChecker} uses the convention to
reflectively construct the components. Otherwise, the checker writer
must specify the component classes for construction.

Expand Down Expand Up @@ -1100,7 +1100,7 @@
MyChecker needs to use.

Override
\<MyChecker.\refmethodterse{common/basetype}{BaseTypeChecker}{getImmediateSubcheckerClasses}{()}>
\<MyChecker.\refmethodterse{framework/common/basetype}{BaseTypeChecker}{getImmediateSubcheckerClasses}{()}>
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
Expand All @@ -1111,7 +1111,7 @@
it) by querying their \refclass{framework/type}{AnnotatedTypeFactory} to
determine the types of variables. Obtain the \<AnnotatedTypeFactory> by
calling
\refmethodterse{common/basetype}{BaseTypeChecker}{getTypeFactoryOfSubcheckerOrNull}{(java.lang.Class)}.
\refmethodterse{framework/common/basetype}{BaseTypeChecker}{getTypeFactoryOfSubcheckerOrNull}{(java.lang.Class)}.

An example of a compound checker is
\refclass{checker/signedness}{SignednessChecker}
Expand Down Expand Up @@ -1180,12 +1180,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/source}{BaseTypeChecker}{getOptions}{()} method in the
\refmethodterse{framework/common/basetype}{BaseTypeChecker}{getOptions}{()} method in the
custom checker class.

For example, to ignore the \<introduce.eliminate> warnings raised by the
Optional Checker (Chapter~\ref{optional-checker}), override
\refmethodterse{framework/source}{BaseTypeChecker}{getOptions}{()} as follows:
\refmethodterse{framework/common/basetype}{BaseTypeChecker}{getOptions}{()} as follows:

\begin{Verbatim}
@Override
Expand Down Expand Up @@ -2233,11 +2233,11 @@

The argument is a comma-separated sequence.
The first element is the fully-qualified name of the
\<org.checkerframework.dataflow.cfg.visualize.>\refclass{org/checkerframework/dataflow/cfg/visualize}{CFGVisualizer} implementation
\<org.checkerframework.dataflow.cfg.visualize.>\refclass{dataflow/cfg/visualize}{CFGVisualizer} implementation
that should be used. Currently, the possibilities are:
\begin{itemize}
\item \<org.checkerframework.dataflow.cfg.visualize.>\refclass{org/checkerframework/dataflow/cfg/visualize}{DOTCFGVisualizer}
\item \<org.checkerframework.dataflow.cfg.visualize.>\refclass{org/checkerframework/dataflow/cfg/visualize}{StringCFGVisualizer}
\item \<org.checkerframework.dataflow.cfg.visualize.>\refclass{dataflow/cfg/visualize}{DOTCFGVisualizer}
\item \<org.checkerframework.dataflow.cfg.visualize.>\refclass{dataflow/cfg/visualize}{StringCFGVisualizer}
\end{itemize}
The remaining keys or key--value pairs are
passed to \<CFGVisualizer.init>. Supported keys include
Expand Down Expand Up @@ -2642,7 +2642,7 @@
Beyond this document,
other useful resources include the Java Infrastructure
Developer's guide at
\url{https://netbeans.apache.org/wiki/Java_DevelopersGuide.html} and the compiler
\url{https://netbeans.apache.org/wiki/main/javahowto/Java_DevelopersGuide/} and the compiler
mailing list archives at
\url{https://mail.openjdk.org/pipermail/compiler-dev/}
(subscribe at
Expand Down
3 changes: 2 additions & 1 deletion docs/manual/faq.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1921,7 +1921,8 @@
or the
tools built into Eclipse (see Section~\ref{faq-eclipse}) and IntelliJ\@.
The \href{https://github.com/uber/NullAway}{NullAway} and
\href{https://fbinfer.com/docs/next/checker-eradicate/}{Eradicate} tools are more
% The eradicate checker has been removed from fbinfer.
\href{https://fbinfer.com/docs/1.1.0/checker-eradicate/}{Eradicate} tools are more
like sound type-checking than bug detection, but all of those tools accept
unsoundness --- that is, false negatives or missed warnings --- in exchange
for analysis speed.
Expand Down

0 comments on commit 33dfb84

Please sign in to comment.