Elementary: replacing doxygen's modules list with a

 custom one.

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@61534 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 0b33b9e..3d25ea8 100644 (file)
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -1,7 +1,7 @@
 PROJECT_NAME           = Elementary
 PROJECT_NUMBER         =
 OUTPUT_DIRECTORY       = .
-INPUT                  = @srcdir@/elementary.dox @srcdir@/examples.dox @top_srcdir@/src/lib/Elementary.h.in @top_srcdir@/src/lib
+INPUT                  = @srcdir@/elementary.dox @srcdir@/examples.dox @top_srcdir@/src/lib/Elementary.h.in @top_srcdir@/src/lib @srcdir@/index.doxy
 IMAGE_PATH             = @srcdir@/img
 OUTPUT_LANGUAGE        = English
 GENERATE_HTML          = YES
@@ -137,3 +137,4 @@ MAX_DOT_GRAPH_HEIGHT   = 512
 GENERATE_LEGEND        = YES
 DOT_CLEANUP            = YES
 SEARCHENGINE           = NO
+LAYOUTFILE             = DoxygenLayout.xml

diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml
new file mode 100644 (file)
index 0000000..e564a40
--- /dev/null
+++ b/doc/DoxygenLayout.xml
@@ -0,0 +1,185 @@
+<doxygenlayout version="1.0">
+  <!-- Navigation index tabs for HTML output -->
+  <navindex>
+    <tab type="mainpage" visible="yes" title=""/>
+    <tab type="pages" visible="yes" title="" intro=""/>
+    <tab type="modules" visible="no" title="" intro=""/>
+    <tab type="namespaces" visible="yes" title="">
+      <tab type="namespaces" visible="yes" title="" intro=""/>
+      <tab type="namespacemembers" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="classes" visible="yes" title="">
+      <tab type="classes" visible="yes" title="" intro=""/>
+      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+      <tab type="hierarchy" visible="yes" title="" intro=""/>
+      <tab type="classmembers" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="files" visible="yes" title="">
+      <tab type="files" visible="yes" title="" intro=""/>
+      <tab type="globals" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="dirs" visible="yes" title="" intro=""/>
+    <tab type="examples" visible="yes" title="" intro=""/>  
+  </navindex>
+
+  <!-- Layout definition for a class page -->
+  <class>
+    <briefdescription visible="yes"/>
+    <includes visible="$SHOW_INCLUDE_FILES"/>
+    <inheritancegraph visible="$CLASS_GRAPH"/>
+    <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+    <allmemberslink visible="yes"/>
+    <memberdecl>
+      <nestedclasses visible="yes" title=""/>
+      <publictypes title=""/>
+      <publicslots title=""/>
+      <signals title=""/>
+      <publicmethods title=""/>
+      <publicstaticmethods title=""/>
+      <publicattributes title=""/>
+      <publicstaticattributes title=""/>
+      <protectedtypes title=""/>
+      <protectedslots title=""/>
+      <protectedmethods title=""/>
+      <protectedstaticmethods title=""/>
+      <protectedattributes title=""/>
+      <protectedstaticattributes title=""/>
+      <packagetypes title=""/>
+      <packagemethods title=""/>
+      <packagestaticmethods title=""/>
+      <packageattributes title=""/>
+      <packagestaticattributes title=""/>
+      <properties title=""/>
+      <events title=""/>
+      <privatetypes title=""/>
+      <privateslots title=""/>
+      <privatemethods title=""/>
+      <privatestaticmethods title=""/>
+      <privateattributes title=""/>
+      <privatestaticattributes title=""/>
+      <friends title=""/>
+      <related title="" subtitle=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <typedefs title=""/>
+      <enums title=""/>
+      <constructors title=""/>
+      <functions title=""/>
+      <related title=""/>
+      <variables title=""/>
+      <properties title=""/>
+      <events title=""/>
+    </memberdef>
+    <usedfiles visible="$SHOW_USED_FILES"/>
+    <authorsection visible="yes"/>
+  </class>
+
+  <!-- Layout definition for a namespace page -->
+  <namespace>
+    <briefdescription visible="yes"/>
+    <memberdecl>
+      <nestednamespaces visible="yes" title=""/>
+      <classes visible="yes" title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+    </memberdef>
+    <authorsection visible="yes"/>
+  </namespace>
+
+  <!-- Layout definition for a file page -->
+  <file>
+    <briefdescription visible="yes"/>
+    <includes visible="$SHOW_INCLUDE_FILES"/>
+    <includegraph visible="$INCLUDE_GRAPH"/>
+    <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+    <sourcelink visible="yes"/>
+    <memberdecl>
+      <classes visible="yes" title=""/>
+      <namespaces visible="yes" title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <functions title=""/>
+      <variables title=""/>
+    </memberdef>
+    <authorsection/>
+  </file>
+
+  <!-- Layout definition for a group page -->
+  <group>
+    <briefdescription visible="yes"/>
+    <groupgraph visible="$GROUP_GRAPHS"/>
+    <memberdecl>
+      <classes visible="yes" title=""/>
+      <namespaces visible="yes" title=""/>
+      <dirs visible="yes" title=""/>
+      <nestedgroups visible="yes" title=""/>
+      <files visible="yes" title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <enumvalues title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <signals title=""/>
+      <publicslots title=""/>
+      <protectedslots title=""/>
+      <privateslots title=""/>
+      <events title=""/>
+      <properties title=""/>
+      <friends title=""/>
+      <membergroups visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdef>
+      <pagedocs/>
+      <inlineclasses title=""/>
+      <defines title=""/>
+      <typedefs title=""/>
+      <enums title=""/>
+      <enumvalues title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <signals title=""/>
+      <publicslots title=""/>
+      <protectedslots title=""/>
+      <privateslots title=""/>
+      <events title=""/>
+      <properties title=""/>
+      <friends title=""/>
+    </memberdef>
+    <authorsection visible="yes"/>
+  </group>
+
+  <!-- Layout definition for a directory page -->
+  <directory>
+    <briefdescription visible="yes"/>
+    <directorygraph visible="yes"/>
+    <memberdecl>
+      <dirs visible="yes"/>
+      <files visible="yes"/>
+    </memberdecl>
+    <detaileddescription title=""/>
+  </directory>
+</doxygenlayout>

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 376dac7..189551b 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -64,7 +64,6 @@ WGT_PREVIEW = \
        index:preview-00.png:widget_preview_index:300:500
 
 widget-preview:
-       @mkdir -p $(top_builddir)/doc/html/img/widget
        @for ss in $(WGT_PREVIEW); do \
                ENTRY=($${ss//:/ }) ; \
                DIR=$${ENTRY[0]} ; \
@@ -73,6 +72,8 @@ widget-preview:
                X=$${ENTRY[3]} ; \
                Y=$${ENTRY[4]} ; \
                $(top_srcdir)/doc/shot.sh $(top_builddir)/doc/html/img/widget/$${DIR} $${SS} $(top_builddir)/doc/$${BIN} $${X} $${Y} ; \
+               mkdir -p $(top_builddir)/doc/latex/img/widget/$${DIR} ; \
+               convert $(top_builddir)/doc/html/img/widget/$${DIR}/$${SS} $(top_builddir)/doc/latex/img/widget/$${DIR}/$${SS/.png/.eps} ; \
        done
 
 doc-clean:

diff --git a/doc/head.html b/doc/head.html
index 4316a5f..ba2fec8 100644 (file)
--- a/doc/head.html
+++ b/doc/head.html
@@ -52,7 +52,7 @@
             <ul class="current">
                 <li><a href="files.html">Files</a></li>
                 <li><a href="Elementary_8h_8in.html">API Reference</a></li>
-                <li><a href="modules.html">Modules</a></li>
+                <li><a href="moduleslist.html">Modules</a></li>
                <li class="current"><a  href="index.html">Main Page</a></li>
             </ul>
         </div>

diff --git a/doc/index.doxy b/doc/index.doxy
new file mode 100644 (file)
index 0000000..66693ce
--- /dev/null
+++ b/doc/index.doxy
@@ -0,0 +1,110 @@
+/**
+ * @page moduleslist Index
+ *
+ * Elementary is mostly composed of widgets, but it also contains some
+ * infrastructure modules that facilitate the use of widgets. These are the
+ * infrastructure modules:
+ * @li @ref Animator
+ * @li @ref Caches
+ * @li @ref Cursors
+ * @li @ref Debug
+ * @li @ref Config
+ * @li @ref Engine
+ * @li @ref Fonts
+ * @li @ref Profile
+ * @li @ref Fingers
+ * @li @ref Focus
+ * @li @ref General
+ * @li @ref Elm_Gesture_Layer
+ * @li @ref Start
+ * @li @ref Scrolling
+ * @li @ref Scrollhints
+ * @li @ref UI-Mirroring
+ * @li @ref Scaling
+ * @li @ref Styles
+ * @li @ref Theme
+ * @li @ref Transit
+ * @li @ref WidgetNavigation
+ *
+ * And here a list of the widgets and some images to give you an idea of what
+ * they are:
+ * @li @ref Actionslider
+ * @li @ref Anchorview
+ * @li @ref Anchorblock
+ * @li @ref Bg
+ * @li @ref Box
+ * @li @ref Bubble
+ *
+ * @image html img/widget/bubble/preview-00.png
+ * @image latex img/widget/bubble/preview-00.eps
+ * @li @ref Button
+ *
+ * @image html img/widget/button/preview-00.png
+ * @image latex img/widget/button/preview-00.eps
+ * @li @ref Calendar
+ * @li @ref Check
+ *
+ * @image html img/widget/check/preview-00.png
+ * @image latex img/widget/check/preview-00.eps
+ * @li @ref Clock
+ * @li @ref Conformant
+ * @li @ref Colorselector
+ *
+ * @image html img/widget/colorselector/preview-00.png
+ * @image latex img/widget/colorselector/preview-00.eps
+ * @li @ref Ctxpopup
+ * @li @ref Diskselector
+ * @li @ref Entry
+ * @li @ref File_Selector_Button
+ *
+ * @image html img/widget/fileselector_button/preview-00.png
+ * @image latex img/widget/fileselector_button/preview-00.eps
+ * @li @ref File_Selector_Entry
+ * @li @ref Fileselector
+ * @li @ref Flip
+ * @li @ref Flipselector
+ * @li @ref Frame
+ * @li @ref Gengrid
+ * @li @ref Genlist
+ * @li @ref Genscroller
+ * @li @ref GLView
+ * @li @ref Grid
+ * @li @ref Hover
+ * @li @ref Hoversel
+ * @li @ref Icon
+ * @li @ref Image
+ * @li @ref Index
+ *
+ * @image html img/widget/index/preview-00.png
+ * @image latex img/widget/index/preview-00.eps
+ * @li @ref Inwin
+ * @li @ref Label
+ * @li @ref Layout
+ * @li @ref List
+ * @li @ref Map
+ * @li @ref Mapbuf
+ * @li @ref Menu
+ * @li @ref Notify
+ * @li @ref Pager
+ * @li @ref Panel
+ * @li @ref Panes
+ * @li @ref Photo
+ * @li @ref Photocam
+ * @li @ref Progressbar
+ * @li @ref Radio
+ * @li @ref Route
+ * @li @ref Scroller
+ * @li @ref SegmentControl
+ * @li @ref Separator
+ * @li @ref Slider
+ * @li @ref Slideshow
+ * @li @ref Spinner
+ * @li @ref Table
+ * @li @ref Thumb
+ * @li @ref Toggle
+ * @li @ref Toolbar
+ * @li @ref Tooltips
+ * @li @ref Video
+ * @li @ref Widget
+ * @li @ref Win
+ */
\ No newline at end of file