diff options
| author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-05-02 17:12:46 +0200 |
|---|---|---|
| committer | Dieter Verfaillie <dieterv@optionexplicit.be> | 2013-10-08 20:53:26 +0200 |
| commit | fd6ebf476f9e55a4ea3b1e88abd05ce72eed1506 (patch) | |
| tree | 69260915f90282440c44ddff13ac88e6de9fe391 | |
| parent | e67a2068e208b6c4ceabdd791e58b96030e42001 (diff) | |
| download | gobject-introspection-fd6ebf476f9e55a4ea3b1e88abd05ce72eed1506.tar.gz | |
README: fix the Tools section a bit
| -rw-r--r-- | README | 15 |
1 files changed, 8 insertions, 7 deletions
@@ -1,6 +1,6 @@ GObject Introspection ===================== -The goal of the project is to describe the APIs and collect them in +The goal of the project is to describe the APIs and collect them in a uniform, machine readable format. GIR XML format @@ -28,16 +28,17 @@ use the information. Tools ===== -Three tools are shipped with GObject Introspection: -- g-ir-compile, a typelib compiler. It converts one or more GIR files +The following tools are shipped with GObject Introspection: +- g-ir-scanner, a tool which generates GIR XML files by parsing headers, + GTK-Doc comment blocks including annotations and introspecting GObject + based libraries. +- g-ir-compiler, a typelib compiler. It converts one or more GIR files into one or more typelib blobs. - g-ir-generate, an GIR generator, using the repository API. It generates GIR files from binary typelib which can be in a shared object, or a raw typelib blob. -- g-ir-scanner, a tool which generates GIR XML files by parsing headers - and introspecting GObject based libraries. -- g-ir-doc-tool, generates Mallard files that can be viewed with yelp or - rendered to HTML with yelp-build from yelp-tools. +- g-ir-annotation-tool, extracts annotations from source code files +- g-ir-doc-tool, generates API reference documentation from a GIR XML file. API library =========== |