Skip to content

Commit

Permalink
Fix some casing and shorten titles in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Washi1337 committed Mar 22, 2023
1 parent e28df25 commit c81797d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 16 deletions.
26 changes: 13 additions & 13 deletions docs/dotnet/type-signatures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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.

Expand All @@ -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:

Expand All @@ -128,8 +128,8 @@ Alternatively, a generic instance can also be generated via the ``MakeGenericTyp
// listOfString now contains a reference to List<string>.
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``:

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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`` |
+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion docs/pdb/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
2 changes: 1 addition & 1 deletion docs/pefile/headers.rst
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/pefile/sections.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit c81797d

Please sign in to comment.