From 2608f68571b277967b2e27d6136c95f03befd183 Mon Sep 17 00:00:00 2001
From: Gustavo Sverzut Barbieri <barbieri@gmail.com>
Date: Fri, 28 Dec 2012 23:26:05 +0000
Subject: efl/docs: clean-up and make it more uniform.

now unified docs are bit more uniform in their start pages, overall
improved but much to do :-(



SVN revision: 81851
---
 src/lib/escape/Escape.h | 41 +++++++++++++++++++++++++++++++++++++----
 1 file changed, 37 insertions(+), 4 deletions(-)

(limited to 'src/lib/escape')

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 @@
 
 /**
  * @page escape_main Escape
- * @date 2011
+ * @date 2011 (created)
  *
- * @section intro_sec Introduction
+ * @section toc Table of Contents
+ *
+ * @li @ref escape_main_intro
+ * @li @ref escape_main_compiling
+ * @li @ref escape_main_next_steps
+ *
+ * @section escape_main_intro Introduction
  *
  * The Escape library is a library that acts implements some of the missing
  * function from the PS3 GameOS system that are needed for the proper
  * functioning of the EFL.
  *
- * @section escape_sec Escape API Documentation
+ * @section escape_main_compiling How to compile
+ *
+ * Escape is a library your application links to. The procedure for
+ * this is very simple. You simply have to compile your application
+ * with the appropriate compiler flags that the @p pkg-config script
+ * outputs. For example:
+ *
+ * Compiling C or C++ files into object files:
+ *
+ * @verbatim
+   gcc -c -o main.o main.c `pkg-config --cflags escape`
+   @endverbatim
+ *
+ * Linking object files into a binary executable:
+ *
+ * @verbatim
+   gcc -o my_application main.o `pkg-config --libs escape`
+   @endverbatim
+ *
+ * See @ref pkgconfig
+ *
+ * @section escape_main_next_steps Next Steps
+ *
+ * After you understood what Escape is and installed it in your system
+ * you should proceed understanding the programming interface.
  *
- * Take a look at the documentation of @ref mmap/munmap.
+ * Recommended reading:
  *
+ * @li @ref Escape_Libgen_Group
+ * @li @ref Escape_Unistd_Group
+ * @li @ref Escape_Mman
  */
 
 #include "escape_libgen.h"
-- 
cgit v1.2.1