diff options
Diffstat (limited to 'src/lib/escape')
-rw-r--r-- | src/lib/escape/Escape.h | 41 |
1 files changed, 37 insertions, 4 deletions
diff --git a/src/lib/escape/Escape.h b/src/lib/escape/Escape.h index c8f6267ec3..210bc872a1 100644 --- a/src/lib/escape/Escape.h +++ b/src/lib/escape/Escape.h | |||
@@ -20,18 +20,51 @@ | |||
20 | 20 | ||
21 | /** | 21 | /** |
22 | * @page escape_main Escape | 22 | * @page escape_main Escape |
23 | * @date 2011 | 23 | * @date 2011 (created) |
24 | * | 24 | * |
25 | * @section intro_sec Introduction | 25 | * @section toc Table of Contents |
26 | * | ||
27 | * @li @ref escape_main_intro | ||
28 | * @li @ref escape_main_compiling | ||
29 | * @li @ref escape_main_next_steps | ||
30 | * | ||
31 | * @section escape_main_intro Introduction | ||
26 | * | 32 | * |
27 | * The Escape library is a library that acts implements some of the missing | 33 | * The Escape library is a library that acts implements some of the missing |
28 | * function from the PS3 GameOS system that are needed for the proper | 34 | * function from the PS3 GameOS system that are needed for the proper |
29 | * functioning of the EFL. | 35 | * functioning of the EFL. |
30 | * | 36 | * |
31 | * @section escape_sec Escape API Documentation | 37 | * @section escape_main_compiling How to compile |
38 | * | ||
39 | * Escape is a library your application links to. The procedure for | ||
40 | * this is very simple. You simply have to compile your application | ||
41 | * with the appropriate compiler flags that the @p pkg-config script | ||
42 | * outputs. For example: | ||
43 | * | ||
44 | * Compiling C or C++ files into object files: | ||
45 | * | ||
46 | * @verbatim | ||
47 | gcc -c -o main.o main.c `pkg-config --cflags escape` | ||
48 | @endverbatim | ||
49 | * | ||
50 | * Linking object files into a binary executable: | ||
51 | * | ||
52 | * @verbatim | ||
53 | gcc -o my_application main.o `pkg-config --libs escape` | ||
54 | @endverbatim | ||
55 | * | ||
56 | * See @ref pkgconfig | ||
57 | * | ||
58 | * @section escape_main_next_steps Next Steps | ||
59 | * | ||
60 | * After you understood what Escape is and installed it in your system | ||
61 | * you should proceed understanding the programming interface. | ||
32 | * | 62 | * |
33 | * Take a look at the documentation of @ref mmap/munmap. | 63 | * Recommended reading: |
34 | * | 64 | * |
65 | * @li @ref Escape_Libgen_Group | ||
66 | * @li @ref Escape_Unistd_Group | ||
67 | * @li @ref Escape_Mman | ||
35 | */ | 68 | */ |
36 | 69 | ||
37 | #include "escape_libgen.h" | 70 | #include "escape_libgen.h" |