From f2ebc98bfa8e780935d76108b897015128c6271e Mon Sep 17 00:00:00 2001
From: Carl Hetherington <cth@carlh.net>
Date: Mon, 1 Dec 2014 09:56:13 +0000
Subject: Some doc improvements.

---
 doc/Doxyfile     |  4 ++--
 doc/mainpage.txt | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 2 deletions(-)
 create mode 100644 doc/mainpage.txt

(limited to 'doc')

diff --git a/doc/Doxyfile b/doc/Doxyfile
index cb03388..829fc35 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -743,7 +743,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src
+INPUT                  = src doc
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -763,7 +763,7 @@ INPUT_ENCODING         = UTF-8
 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
 # *.qsf, *.as and *.js.
 
-FILE_PATTERNS          =
+FILE_PATTERNS          = *.cc *.h *.txt
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
diff --git a/doc/mainpage.txt b/doc/mainpage.txt
new file mode 100644
index 0000000..642cff6
--- /dev/null
+++ b/doc/mainpage.txt
@@ -0,0 +1,36 @@
+/*!
+
+@mainpage libsub
+
+libsub is a library to read and write subtitles in a variety of formats.  It can be used to read subtitles for
+processing, to write them or to convert between formats.
+
+The current version has reasonable support for the following subtitle formats:
+- Digital Cinema Package (DCP) XML
+- SubRip (.srt)
+- EBU-STL text and binary
+
+
+Reading subtitles
+--
+
+The basic process is:
+
+    shared_ptr<sub::Reader> reader = reader_factory (filename);
+    list<sub::Subtitle> subs = collect<list<sub::Subtitle> > (reader->subtitles ());
+
+We first have:
+
+    shared_ptr<sub::Reader> reader = reader_factory (filename);
+ 
+This looks at the extension of `filename' and, if necessary, its header, and guesses
+what format it is in.  Based on the format it creates an appropriate Reader object.
+This reader object can then return its subtitles using
+
+    reader->subtitles ();
+
+    
+
+
+
+*/
-- 
cgit v1.2.3