From c81797de32aae3ddb18d7c0ab0e3e31b14415548 Mon Sep 17 00:00:00 2001 From: Washi Date: Wed, 22 Mar 2023 14:18:20 +0100 Subject: [PATCH] Fix some casing and shorten titles in docs. --- docs/dotnet/type-signatures.rst | 26 +++++++++++++------------- docs/pdb/index.rst | 3 ++- docs/pefile/headers.rst | 2 +- docs/pefile/sections.rst | 2 +- 4 files changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/dotnet/type-signatures.rst b/docs/dotnet/type-signatures.rst index e98940e72..8803693cd 100644 --- a/docs/dotnet/type-signatures.rst +++ b/docs/dotnet/type-signatures.rst @@ -11,8 +11,8 @@ All relevant classes in this document can be found in the following namespaces: using AsmResolver.DotNet.Signatures.Types; -Overview of all Type Signatures -------------------------------- +Overview +-------- Basic leaf type signatures: @@ -78,8 +78,8 @@ Corlib type signatures can also be looked up by their element type, by their ful If an invalid element type, name or type descriptor is passed on, these methods return ``null``. -TypeDefOrRefSignature ---------------------- +Class and Struct Types +---------------------- The ``TypeDefOrRefSignature`` class is used to reference types in either the ``TypeDef`` or ``TypeRef`` (and sometimes ``TypeSpec``) metadata table. @@ -101,8 +101,8 @@ Alternatively, ``CreateTypeReference`` can be used on any ``IResolutionScope``: While it is technically possible to reference a basic type such as ``System.Int32`` as a ``TypeDefOrRefSignature``, it renders the .NET module invalid by most implementations of the CLR. Always use the ``CorLibTypeSignature`` to reference basic types within your blob signatures. -GenericInstanceTypeSignature ----------------------------- +Generic Instance Types +---------------------- The ``GenericInstanceTypeSignature`` class is used to instantiate generic types with type arguments: @@ -128,8 +128,8 @@ Alternatively, a generic instance can also be generated via the ``MakeGenericTyp // listOfString now contains a reference to List. -FunctionPointerTypeSignature ----------------------------- +Function Pointer Types +---------------------- Function pointer signatures are strongly-typed pointer types used to describe addresses to functions or methods. In AsmResolver, they are represented using a ``MethodSignature``: @@ -175,8 +175,8 @@ To quickly transform any ``ITypeDescriptor`` into a ``TypeSignature``, it is pos Likewise, a ``TypeSignature`` can also be converted back to a ``ITypeDefOrRef``, which can be referenced using a metadata token, using the ``TypeSignature.ToTypeDefOrRef()`` method. -Decorating type signatures --------------------------- +Decorating Types +---------------- Type signatures can be annotated with extra properties, such as an array or pointer specifier. @@ -205,7 +205,7 @@ Below an overview of all factory shortcut methods: +===================================================================+==================================================================================================================+ | ``MakeArrayType(int dimensionCount)`` | Wraps the type in a new ``ArrayTypeSignature`` with ``dimensionCount`` zero based dimensions with no upperbound. | +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ -| ``MakeArrayType(ArrayDimension[] dimensinos)`` | Wraps the type in a new ``ArrayTypeSignature`` with ``dimensions`` set as dimensions | +| ``MakeArrayType(ArrayDimension[] dimensions)`` | Wraps the type in a new ``ArrayTypeSignature`` with ``dimensions`` set as dimensions | +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ | ``MakeByReferenceType()`` | Wraps the type in a new ``ByReferenceTypeSignature`` | +-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ @@ -222,8 +222,8 @@ Below an overview of all factory shortcut methods: -Comparing Type Signatures -------------------------- +Comparing Types +--------------- Type signatures can be tested for semantic equivalence using the ``SignatureComparer`` class. Most use-cases of this class will not require any customization. diff --git a/docs/pdb/index.rst b/docs/pdb/index.rst index d3e30af79..f6adf7c65 100644 --- a/docs/pdb/index.rst +++ b/docs/pdb/index.rst @@ -4,7 +4,8 @@ Overview The Program Database (PDB) file format is a format developed by Microsoft for storing debugging information about binary files. PDBs are typically constructed based on the original source code the binary was compiled with, and lists various symbols that the source code defines and/or references. -Since version 5.0, AsmResolver provides a work-in-progress implementation for reading (and sometimes writing) PDB files to allow for better analysis of compiled binaries. This implementation is fully managed, and thus does not depend on libraries such as the Debug Interface Access (DIA) that only work on the Windows platform. +Since version 5.0, AsmResolver provides a work-in-progress implementation for reading (and sometimes writing) PDB files to allow for better analysis of compiled binaries. +This implementation is fully managed, and thus does not depend on libraries such as the Debug Interface Access (DIA) that only work on the Windows platform. Furthermore, this project also aims to provide additional documentation on the file format, to make it more accessible to other developers. .. warning:: diff --git a/docs/pefile/headers.rst b/docs/pefile/headers.rst index fc011d58d..f320af19e 100644 --- a/docs/pefile/headers.rst +++ b/docs/pefile/headers.rst @@ -1,4 +1,4 @@ -PE headers +PE Headers ========== After you obtained an instance of the ``PEFile`` class, it is possible to read and edit various properties in the DOS header, COFF file header and optional header. They each have a designated property: diff --git a/docs/pefile/sections.rst b/docs/pefile/sections.rst index 605425cb6..2ff88951c 100644 --- a/docs/pefile/sections.rst +++ b/docs/pefile/sections.rst @@ -1,6 +1,6 @@ .. _pe-file-sections: -PE sections +PE Sections =========== Sections can be read and modified by accessing the ``PEFile.Sections`` property, which is a collection of ``PESection`` objects.