Skip to content
Browse files

Switch readme to markdown

  • Loading branch information...
1 parent 15362b6 commit 1b3e627d086ae04f1433e4a4ebb0ff14af4871fb @jbevain committed
Showing with 54 additions and 26 deletions.
  1. +0 −26 README
  2. +54 −0 README.md
View
26 README
@@ -1,26 +0,0 @@
-Mono.Reflection
---
-
-Mono.Reflection is an helper library to complement the System.Reflection
-and System.Reflection.Emit namespaces. It is known to work on both
-Mono 2.4 and .net 3.5.
-
-API
---
-
- bool Image.IsAssembly (string)
- bool Image.IsAssembly (Stream)
-
- Test whether a file is a managed assembly or not.
-
- FieldInfo BackingFieldResolver.GetBackingField (this PropertyInfo)
-
- Returns the field backing a property or throws an
- InvalidOperationException.
-
- IList<Instruction> Disassembler.GetInstructions (this MethodBase)
-
- Disassemble a list of IL instructions from the method body
- or throws an ArgumentException if the method doesn't provide
- a body.
-
View
54 README.md
@@ -0,0 +1,54 @@
+## Mono.Reflection
+
+Mono.Reflection is an helper library to complement the System.Reflection and System.Reflection.Emit namespaces.
+
+It works on both Mono >= 2.8 and .net >= 4.0.
+
+## API
+
+***
+
+```csharp
+public sealed class Image {
+ public static bool IsAssembly (string fileName) {}
+ public static bool IsAssembly (Stream stream) {}
+}
+```
+
+> Test whether a file is a managed assembly or not.
+
+***
+
+```csharp
+public static class BackingFieldResolver {
+ public static FieldInfo GetBackingField (this PropertyInfo self) {}
+}
+```
+
+> Returns the field backing a property or throws an InvalidOperationException.
+
+***
+
+```csharp
+public static class Disassembler {
+ public static IList<Instruction> GetInstructions (this MethodBase self) {}
+}
+```
+
+> Returns a read only collection of Instruction representing the
+> IL method body or throws an ArgumentException if the method doesn't provide a body.
+
+***
+
+```csharp
+public class Instruction {
+ public int Offset { get; }
+ public OpCode OpCode { get; }
+ public object Operand { get; }
+
+ public Instruction Next { get; }
+ public Instruction Previous { get; }
+}
+```
+
+> Represents an IL instruction.

0 comments on commit 1b3e627

Please sign in to comment.
Something went wrong with that request. Please try again.