[latexila/wip/templates-revamp: 5/5] liblatexila: explain the purpose of latexila.h and latexila-types.h

[Sébastien Wilmet <swilmet src gnome org>]

commit 36c5b2cd3bd6d484c08f391fa5ae26c098a023b1
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Thu May 28 17:53:57 2015 +0200

    liblatexila: explain the purpose of latexila.h and latexila-types.h

 src/liblatexila/latexila-types.h |    5 +++++
 src/liblatexila/latexila.h       |    4 ++++
 2 files changed, 9 insertions(+), 0 deletions(-)
---
diff --git a/src/liblatexila/latexila-types.h b/src/liblatexila/latexila-types.h
index b944efa..eeed9d3 100644
--- a/src/liblatexila/latexila-types.h
+++ b/src/liblatexila/latexila-types.h
@@ -17,6 +17,11 @@
  * along with LaTeXila.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/* Every type is defined here. It avoids problems with header #includes cycles.
+ * For example when type-a.h needs the TypeB declaration, and type-b.h needs the
+ * TypeA declaration.
+ */
+
 #ifndef __LATEXILA_TYPES_H__
 #define __LATEXILA_TYPES_H__
 
diff --git a/src/liblatexila/latexila.h b/src/liblatexila/latexila.h
index 1b36265..b0b305c 100644
--- a/src/liblatexila/latexila.h
+++ b/src/liblatexila/latexila.h
@@ -17,6 +17,10 @@
  * along with LaTeXila.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/* Main header for the LaTeXila "library". Code using the library (e.g. Vala
+ * code) should #include only this header.
+ */
+
 #ifndef __LATEXILA_H__
 #define __LATEXILA_H__