docs: tidy up 'codeql for x' pages

Manually construct tocs including intro text.
Fix a few intros and titles.
This commit is contained in:
james
2020-03-26 10:55:36 +00:00
parent 55f9034712
commit deb657acdb
11 changed files with 82 additions and 62 deletions

View File

@@ -1,7 +1,7 @@
CodeQL libraries for C#
=======================
CodeQL library for C#
=====================
When you're analyzing a C# program, you can make use of the large collection of classes in the CodeQL libraries for C#.
When you're analyzing a C# program, you can make use of the large collection of classes in the CodeQL library for C#.
About the CodeQL libraries for C#
---------------------------------

View File

@@ -1,29 +1,21 @@
CodeQL for C#
=============
You can use CodeQL to explore C# programs and quickly find variants of security vulnerabilities and bugs.
Experiment and learn how to write effective and efficient queries for CodeQL databases generated from C# codebases.
.. toctree::
:glob:
:hidden:
introduce-libraries-csharp
dataflow
These topics provide an overview of the CodeQL libraries for C# and show examples of how to use them.
- `Basic C# query <https://lgtm.com/help/lgtm/console/ql-csharp-basic-example>`__: Learn to write and run a simple CodeQL query using LGTM.
- `Basic C# query <https://lgtm.com/help/lgtm/console/ql-csharp-basic-example>`__ describes how to write and run queries using LGTM.
- :doc:`CodeQL library for C# <introduce-libraries-csharp>`: When you're analyzing a C# program, you can make use of the large collection of classes in the CodeQL library for C#.
- :doc:`Introducing the CodeQL libraries for C# <introduce-libraries-csharp>` introduces the standard libraries used to write queries for C# code.
- :doc:`Analyzing data flow in C# <dataflow>`: You can use CodeQL to track the flow of data through a C# program to its use.
.. raw:: html
<!-- Working with generic types and methods(generics) - how to query generic types and methods. -->
- :doc:`Analyzing data flow in C# <dataflow>` demonstrates how to write queries using the standard data flow and taint tracking libraries for C#.
Other resources
Further reading
---------------
- For examples of how to query common C# elements, see the `C# cookbook <https://help.semmle.com/wiki/display/CBCSHARP>`__.