Skip to content

Commit fdbc748

Browse files
hubwriterhubwriter
committed
Java topics - change titles & add intros
1 parent bcb4759 commit fdbc748

10 files changed

Lines changed: 38 additions & 20 deletions

‎docs/language/learn-ql/java/annotations.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Tutorial: Annotations
2-
=====================
1+
Annotations in Java
2+
===================
3+
4+
CodeQL databases of Java projects contain information about all annotations attached to program elements.
35

46
Overview
57
--------
68

7-
CodeQL databases of Java projects contain information about all annotations attached to program elements.
8-
99
Annotations are represented by the following CodeQL classes:
1010

1111
- The class ``Annotatable`` represents all entities that may have an annotation attached to them (that is, packages, reference types, fields, methods, and local variables).

‎docs/language/learn-ql/java/ast-class-reference.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
AST class reference
2-
===================
1+
Abstract syntax tree classes in Java
2+
====================================
3+
4+
CodeQL has a large selection of classes for working with Java code.
35

46
.. _Expr: https://help.semmle.com/qldoc/java/semmle/code/java/Expr.qll/type.Expr$Expr.html
57
.. _Stmt: https://help.semmle.com/qldoc/java/semmle/code/java/Statement.qll/type.Statement$Stmt.html

‎docs/language/learn-ql/java/call-graph.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Tutorial: Navigating the call graph
2-
===================================
1+
Navigating the call graph
2+
=========================
3+
4+
CodeQL provides an API for identifying code that calls other code, and code that can be called from elsewhere. This allows you to find, for example, methods that are never used.
35

46
Call graph API
57
--------------

‎docs/language/learn-ql/java/dataflow.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
Analyzing data flow in Java
2-
============================
2+
===========================
3+
4+
You can use CodeQL to track the flow of data through a Java program to its use.
35

46
Overview
57
--------
68

79
This topic describes how data flow analysis is implemented in the CodeQL libraries for Java and includes examples to help you write your own data flow queries.
8-
The following sections describe how to utilize the libraries for local data flow, global data flow, and taint tracking.
10+
The following sections describe how to use the libraries for local data flow, global data flow, and taint tracking.
911

1012
For a more general introduction to modeling data flow, see :doc:`Introduction to data flow analysis with CodeQL <../intro-to-data-flow>`.
1113

‎docs/language/learn-ql/java/expressions-statements.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Tutorial: Expressions and statements
2-
====================================
1+
Expressions and statements in Java
2+
==================================
3+
4+
You can use CodeQL to check for comparisons in Java code where one side of the comparison is prone to overflow.
35

46
Overview
57
--------

‎docs/language/learn-ql/java/introduce-libraries-java.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Introducing the CodeQL libraries for Java
2-
=========================================
1+
CodeQL library for Java
2+
=======================
3+
4+
When you need to analyze a Java program, you can make use of the large collection of classes in the Java library for CodeQL.
35

46
Overview
57
--------

‎docs/language/learn-ql/java/javadoc.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Tutorial: Javadoc
2-
=================
1+
Javadoc
2+
=======
3+
4+
You can use CodeQL to find errors in Javadoc comments in Java code.
35

46
Overview
57
--------

‎docs/language/learn-ql/java/ql-for-java.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
CodeQL for Java
22
===============
33

4+
You can use CodeQL to explore Java programs and quickly find variants of security vulnerabilities and bugs.
5+
46
.. toctree::
57
:glob:
68
:hidden:

‎docs/language/learn-ql/java/source-locations.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Tutorial: Working with source locations
2-
=======================================
1+
Working with source locations
2+
=============================
3+
4+
You can use the location of entities within Java code to look for potential errors. Locations allow you to deduce the presence, or absence, of white space which, in some cases, may indicate a problem.
35

46
Overview
57
--------

‎docs/language/learn-ql/java/types-class-hierarchy.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
Tutorial: Types and the class hierarchy
2-
=======================================
1+
Types in Java
2+
=============
3+
4+
You can use CodeQL to find out information about data types used in Java code. This allows you to write queries to identify specific type-related issues.
35

46
Overview
57
--------

0 commit comments

Comments
 (0)