Improve the documentation.

doc/doxygen_extra.css

@@ -116,21 +116,18 @@ a.el {
   font-style:italic;
 }
 
-#projectname
+#projectname {
-{
   font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
   font-size: 2em;
   font-weight: bold;
 }
 
-#projectbrief
+#projectbrief {
-{
   font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
   font-size: 0.8em;
 }
 
-#projectnumber
+#projectnumber {
-{
   font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
   font-size: 1em;
 }
@@ -151,8 +148,7 @@ div.toc {
   border-radius: 7px;
 }
 
-div.header
+div.header {
-{
   width: 980px;
   padding: 10px;
   margin-top: 10px;
@@ -164,8 +160,7 @@ div.header
   border: 1px solid #d1d5da;
 }
 
-div.headertitle
+div.headertitle {
-{
   padding: 0;
 }
 

doc/doxygen_layout.xml

@@ -1,25 +1,36 @@
 <doxygenlayout version="1.0">
-  <!-- Generated by doxygen 1.8.14 -->
   <!-- Navigation index tabs for HTML output -->
   <navindex>
-    <tab type="mainpage" visible="yes" title=""/>
+    <tab type="mainpage" visible="yes" title="Tutorial"/>
+    <tab type="examples" visible="yes" title="" intro=""/>  
+    <tab type="filelist" visible="yes" title=""/>
+
     <tab type="pages" visible="yes" title="" intro=""/>
-    <tab type="modules" visible="yes" title="C modules" intro=""/>
+    <tab type="modules" visible="yes" title="" intro=""/>
     <tab type="namespaces" visible="yes" title="">
       <tab type="namespacelist" visible="yes" title="" intro=""/>
       <tab type="namespacemembers" visible="yes" title="" intro=""/>
     </tab>
-    <tab type="classes" visible="yes" title="">
+    <tab type="interfaces" visible="no" title="">
+      <tab type="interfacelist" visible="yes" title="" intro=""/>
+      <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+      <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
+    </tab>
+    <tab type="classes" visible="no" title="">
       <tab type="classlist" 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="structs" visible="no" title="">
-      <tab type="filelist" visible="yes" title="" intro=""/>
+      <tab type="structlist" visible="yes" title="" intro=""/>
-      <tab type="globals" visible="yes" title="" intro=""/>
+      <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+    </tab>
+    <tab type="exceptions" visible="no" title="">
+      <tab type="exceptionlist" visible="yes" title="" intro=""/>
+      <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+      <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
     </tab>
-    <tab type="examples" visible="yes" title="" intro=""/>  
   </navindex>
 
   <!-- Layout definition for a class page -->
@@ -87,8 +98,13 @@
     <memberdecl>
       <nestednamespaces visible="yes" title=""/>
       <constantgroups visible="yes" title=""/>
+      <interfaces visible="yes" title=""/>
       <classes visible="yes" title=""/>
+      <structs visible="yes" title=""/>
+      <exceptions visible="yes" title=""/>
       <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
@@ -98,6 +114,8 @@
     <memberdef>
       <inlineclasses title=""/>
       <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
@@ -113,11 +131,16 @@
     <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
     <sourcelink visible="yes"/>
     <memberdecl>
+      <interfaces visible="yes" title=""/>
       <classes visible="yes" title=""/>
+      <structs visible="yes" title=""/>
+      <exceptions visible="yes" title=""/>
       <namespaces visible="yes" title=""/>
       <constantgroups visible="yes" title=""/>
       <defines title=""/>
-      <typedes title=""/>
+      <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
@@ -128,6 +151,8 @@
       <inlineclasses title=""/>
       <defines title=""/>
       <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
@@ -137,8 +162,7 @@
 
   <!-- Layout definition for a group page -->
   <group>
-    <briefdescription visible="no"/>
+    <briefdescription visible="yes"/>
-    <detaileddescription title="Description"/>
     <groupgraph visible="$GROUP_GRAPHS"/>
     <memberdecl>
       <nestedgroups visible="yes" title=""/>
@@ -148,6 +172,8 @@
       <classes visible="yes" title=""/>
       <defines title=""/>
       <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
       <enums title=""/>
       <enumvalues title=""/>
       <functions title=""/>
@@ -161,11 +187,14 @@
       <friends title=""/>
       <membergroups visible="yes"/>
     </memberdecl>
+    <detaileddescription title=""/>
     <memberdef>
       <pagedocs/>
       <inlineclasses title=""/>
       <defines title=""/>
       <typedefs title=""/>
+      <sequences title=""/>
+      <dictionaries title=""/>
       <enums title=""/>
       <enumvalues title=""/>
       <functions title=""/>

doc/mainpage.md

@@ -45,7 +45,7 @@ int main(void) {
 ```
 
 **cmake**
-```
+```c
 cmake_minimum_required (VERSION 3.11)
 
 include(FetchContent)
@@ -144,15 +144,12 @@ This provides:
 # ftxui/dom
 
 Every elements of the dom are declared from:
-
+\ref ftxui/dom/elements.hpp
-\include ftxui/dom/elements.hpp
 
 ## text
 
 The most simple widget. It displays a text.
 ~~~cpp
-using namespace ftxui;
-
 text(L"I am a piece of text");
 ~~~
 ~~~bash
@@ -163,8 +160,6 @@ I am a piece of text.
 
 Add a border around an element
 ~~~cpp
-using namespace ftxui;
-
 border(text(L"The element"))
 ~~~
 
@@ -179,8 +174,6 @@ border(text(L"The element"))
 A ftxui::window is a ftxui::border, but with some text on top of the border.
 Add a border around an element
 ~~~cpp
-using namespace ftxui;
-
 window(L"The window", text(L"The element"))
 ~~~
 
@@ -378,8 +371,8 @@ Assuming this example example.cpp file.
 
 **main.cpp**
 ~~~cpp
-#include "ftxui/screen/screen.hpp"
+#include "ftxui/screen/screen.c
-#include "ftxui/dom/elements.hpp"
+#include "ftxui/dom/elements.c
 #include <iostream>
 
 int main(int argc, const char *argv[]) {