update documentation

wsekta · Jan 11, 2024 · 3e4ea82 · 3e4ea82
1 parent 2aa6ff6
commit 3e4ea82
Show file tree

Hide file tree

Showing 9 changed files with 408 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -34,4 +34,6 @@
 *build*/
 .idea/
 .vscode/
-vcpkg_installed/
+vcpkg_installed/
+html/
+doxygen-awesome-css
diff --git a/Doxyfile b/Doxyfile
@@ -351,7 +351,7 @@ EXTENSION_MAPPING      =
 # case of backward compatibilities issues.
 # The default value is: YES.
 
-MARKDOWN_SUPPORT       = NO
+MARKDOWN_SUPPORT       = YES
 
 # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
 # to that level are automatically included in the table of contents, even if
@@ -906,7 +906,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = include/orm-cxx
+INPUT                  = docs/ include/orm-cxx/
 
 # 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
@@ -1328,10 +1328,8 @@ HTML_STYLESHEET        =
 # list). For an example see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-# HTML_EXTRA_STYLESHEET  = doxygen-awesome-css/doxygen-awesome.css \
-#                                                  doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
-#                                                  docs/main.css
-
+HTML_EXTRA_STYLESHEET  = doxygen-awesome-css/doxygen-awesome.css \
+                                                 doxygen-awesome-css/doxygen-awesome-sidebar-only.css
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note

diff --git a/README.md b/README.md
@@ -68,7 +68,9 @@ int main()
 
 ## 📖 Documentation
 
-https://wsekta.github.io/orm-cxx/
+## [Markdown](docs/main.md)
+
+## [Doxygen](https://wsekta.github.io/orm-cxx/)
 
 ## Consuming library with CMake (CMake 3.22 or newer)
 

diff --git a/docs/DoxygenLayout.xml b/docs/DoxygenLayout.xml
@@ -0,0 +1,240 @@
+<doxygenlayout version="1.0">
+    <!-- Generated by doxygen 1.9.4 -->
+    <!-- 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="no" title="">
+            <tab type="namespacelist" visible="no" title="" intro=""/>
+            <tab type="namespacemembers" visible="no" title="" intro=""/>
+        </tab>
+        <tab type="concepts" visible="no" title="">
+        </tab>
+        <tab type="interfaces" visible="no" title="">
+            <tab type="interfacelist" visible="no" title="" intro=""/>
+            <tab type="interfaceindex" visible="no" title=""/>
+            <tab type="interfacehierarchy" visible="no" title="" intro=""/>
+        </tab>
+        <tab type="classes" visible="yes" title="API">
+            <tab type="classlist" visible="yes" title="Modules" intro=""/>
+            <tab type="classindex" visible="no" title=""/>
+            <tab type="hierarchy" visible="no" title="" intro=""/>
+            <tab type="classmembers" visible="no" title="" intro=""/>
+        </tab>
+        <tab type="structs" visible="no" title="">
+            <tab type="structlist" visible="no" title="" intro=""/>
+            <tab type="structindex" visible="no" title=""/>
+        </tab>
+        <tab type="exceptions" visible="no" title="">
+            <tab type="exceptionlist" visible="no" title="" intro=""/>
+            <tab type="exceptionindex" visible="no" title=""/>
+            <tab type="exceptionhierarchy" visible="no" title="" intro=""/>
+        </tab>
+        <tab type="files" visible="no" title="">
+            <tab type="filelist" visible="no" title="" intro=""/>
+            <tab type="globals" visible="no" title="" intro=""/>
+        </tab>
+        <tab type="examples" visible="no" title="" intro=""/>
+    </navindex>
+
+    <!-- Layout definition for a class page -->
+    <class>
+        <briefdescription visible="yes"/>
+        <includes visible="$SHOW_HEADERFILE"/>
+        <inheritancegraph visible="$CLASS_GRAPH"/>
+        <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+        <memberdecl>
+            <nestedclasses visible="yes" title=""/>
+            <publictypes title=""/>
+            <services title=""/>
+            <interfaces 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>
+            <inlineclasses title=""/>
+            <typedefs title=""/>
+            <enums title=""/>
+            <services title=""/>
+            <interfaces title=""/>
+            <constructors title=""/>
+            <functions title=""/>
+            <related title=""/>
+            <variables title=""/>
+            <properties title=""/>
+            <events title=""/>
+        </memberdef>
+        <allmemberslink visible="yes"/>
+        <usedfiles visible="$SHOW_USED_FILES"/>
+        <authorsection visible="yes"/>
+    </class>
+
+    <!-- Layout definition for a namespace page -->
+    <namespace>
+        <briefdescription visible="yes"/>
+        <memberdecl>
+            <nestednamespaces visible="yes" title=""/>
+            <constantgroups visible="yes" title=""/>
+            <interfaces visible="yes" title=""/>
+            <classes visible="yes" title=""/>
+            <concepts visible="yes" title=""/>
+            <structs visible="yes" title=""/>
+            <exceptions visible="yes" title=""/>
+            <typedefs title=""/>
+            <sequences title=""/>
+            <dictionaries title=""/>
+            <enums title=""/>
+            <functions title=""/>
+            <variables title=""/>
+            <membergroups visible="yes"/>
+        </memberdecl>
+        <detaileddescription title=""/>
+        <memberdef>
+            <inlineclasses title=""/>
+            <typedefs title=""/>
+            <sequences title=""/>
+            <dictionaries title=""/>
+            <enums title=""/>
+            <functions title=""/>
+            <variables title=""/>
+        </memberdef>
+        <authorsection visible="yes"/>
+    </namespace>
+
+    <!-- Layout definition for a concept page -->
+    <concept>
+        <briefdescription visible="yes"/>
+        <includes visible="$SHOW_HEADERFILE"/>
+        <definition visible="yes" title=""/>
+        <detaileddescription title=""/>
+        <authorsection visible="yes"/>
+    </concept>
+
+    <!-- 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>
+            <interfaces visible="yes" title=""/>
+            <classes visible="yes" title=""/>
+            <structs visible="yes" title=""/>
+            <exceptions visible="yes" title=""/>
+            <namespaces visible="yes" title=""/>
+            <concepts visible="yes" title=""/>
+            <constantgroups visible="yes" title=""/>
+            <defines title=""/>
+            <typedefs title=""/>
+            <sequences title=""/>
+            <dictionaries title=""/>
+            <enums title=""/>
+            <functions title=""/>
+            <variables title=""/>
+            <membergroups visible="yes"/>
+        </memberdecl>
+        <detaileddescription title=""/>
+        <memberdef>
+            <inlineclasses title=""/>
+            <defines title=""/>
+            <typedefs title=""/>
+            <sequences title=""/>
+            <dictionaries 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>
+            <nestedgroups visible="yes" title=""/>
+            <dirs visible="yes" title=""/>
+            <files visible="yes" title=""/>
+            <namespaces visible="yes" title=""/>
+            <concepts visible="yes" title=""/>
+            <classes visible="yes" title=""/>
+            <defines title=""/>
+            <typedefs title=""/>
+            <sequences title=""/>
+            <dictionaries 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=""/>
+            <sequences title=""/>
+            <dictionaries 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/docs/database.md b/docs/database.md
@@ -0,0 +1,9 @@
+# Database
+
+1. [Connect](#connect)
+2. [Create table](#create-table)
+3. [Delete table](#delete-table)
+4. [Insert objects](#insert-objects)
+5. [Query objects](#query-objects)
+
+🚧🚧🚧 TODO 🚧🚧🚧
diff --git a/docs/main.md b/docs/main.md
@@ -1,8 +1,14 @@
 <div align="center">
   <h1>ORM C++</h1>
   <p>ORM Library for Modern C++(C++20) using native reflection.</p>
-  
+
 [![clang++](https://github.com/wsekta/orm-cxx/actions/workflows/linux-clang-build.yml/badge.svg?branch=main)](https://github.com/wsekta/orm-cxx/actions/workflows/linux-clang-build.yml?query=branch%3Amain)
 [![g++](https://github.com/wsekta/orm-cxx/actions/workflows/linux-gxx-build.yml/badge.svg?branch=main)](https://github.com/wsekta/orm-cxx/actions/workflows/linux-gxx-build.yml?query=branch%3Amain)
 [![msvc](https://github.com/wsekta/orm-cxx/actions/workflows/windows-msvc-build.yml/badge.svg?branch=main)](https://github.com/wsekta/orm-cxx/actions/workflows/windows-msvc-build.yml?query=branch%3Amain)
-[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+</div>
+
+1. <[Model](model.md)>
+2. [Query](query.md)
+3. [Database](database.md)