Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update code and instructions for the homepage, including doxygen and the WASM app #481

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ direction - please contact support@qskinny.org.

![IOT dashboard](/doc/images/iotdashboard.png)


# Contributing to QSkinny
# Contributing

QSkinny is licensed under the BSD 3 Clause License ( https://opensource.org/license/bsd-3-clause ). However we want to be able to offer more licenses on request.

Expand Down
25 changes: 14 additions & 11 deletions doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = api
OUTPUT_DIRECTORY =

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
Expand Down Expand Up @@ -278,7 +278,9 @@ ALIASES = "accessors=\par Access functions:^^" \
"states=\par States:^^" \
"skinlet=\par Default Skinlet:^^" \
"aspect=\par Aspect^^" \
"saqt=\sa ^^"
"embedWasm=<div> <div id=\"qtspinner\"> <div id=\"qtstatus\"></div> </div> <div id=\"qt-wasm-screen\"> </div> </div>"



# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
Expand Down Expand Up @@ -938,9 +940,10 @@ WARN_LOGFILE = Doxygen.log
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = . \
classes \
../src
INPUT = classes \
../src \
tutorials \
../README.md

# 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
Expand Down Expand Up @@ -1113,7 +1116,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = ../README.md

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down Expand Up @@ -1313,7 +1316,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_HEADER =
HTML_HEADER = header.html

# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
Expand All @@ -1323,7 +1326,7 @@ HTML_HEADER =
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_FOOTER =
HTML_FOOTER = footer.html

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
Expand Down Expand Up @@ -1353,7 +1356,7 @@ HTML_STYLESHEET =
# documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET = ./customdoxygen.css
HTML_EXTRA_STYLESHEET = ./doxygen-awesome.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
Expand All @@ -1376,7 +1379,7 @@ HTML_EXTRA_FILES =
# The default value is: AUTO_LIGHT.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_COLORSTYLE = AUTO_LIGHT
HTML_COLORSTYLE = LIGHT

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
Expand Down Expand Up @@ -1696,7 +1699,7 @@ GENERATE_TREEVIEW = YES
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

FULL_SIDEBAR = YES
FULL_SIDEBAR = NO

# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
# doxygen will group on one line in the generated HTML documentation.
Expand Down
101 changes: 70 additions & 31 deletions doc/DoxygenLayout.xml
Original file line number Diff line number Diff line change
@@ -1,61 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>
<doxygenlayout version="1.0">
<!-- Generated by doxygen 1.8.20 -->
<!-- Generated by doxygen 1.9.8 -->
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title="Home"/>
<tab type="pages" visible="no" title="" intro=""/>
<tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="yes" title="" intro=""/>
<tab type="topics" visible="yes" title="" intro=""/>
<tab type="modules" visible="yes" title="" intro="">
<tab type="modulelist" visible="yes" title="" intro=""/>
<tab type="modulemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="no" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="concepts" visible="yes" title="">
</tab>
<tab type="interfaces" visible="yes" title="">
<tab type="interfacelist" visible="yes" title="" intro=""/>
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="interfacehierarchy" visible="no" title="" intro=""/>
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="modules" visible="yes" title="Groups" intro=""/>
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="no" title="" intro=""/>
<tab type="classmembers" visible="no" 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="structs" visible="yes" title="">
<tab type="structlist" visible="yes" title="" intro=""/>
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
</tab>
<tab type="exceptions" visible="no" title="">
<tab type="exceptionlist" visible="no" title="" intro=""/>
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="exceptionhierarchy" visible="no" title="" intro=""/>
<tab type="exceptions" visible="yes" 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="files" visible="no" title="">
<tab type="filelist" visible="no" title="" intro=""/>
<tab type="globals" visible="no" title="" intro=""/>
<tab type="files" visible="yes" title="">
<tab type="filelist" visible="yes" title="" intro=""/>
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
<tab type="examples" visible="no" title="" intro=""/>
<tab type="examples" visible="yes" title="" intro=""/>
</navindex>

<!-- Layout definition for a class page -->
<class>
<briefdescription visible="no"/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<briefdescription visible="yes"/>
<includes visible="$SHOW_HEADERFILE"/>
<detaileddescription title=""/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<collaborationgraph visible="yes"/>
<memberdecl>
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<services title=""/>
<related title="" subtitle=""/>
<interfaces title=""/>
<properties title=""/>
<publicattributes title=""/>
<publicstaticattributes title=""/>
<publicmethods title=""/>
<publicstaticmethods title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title=""/>
<publicstaticmethods title=""/>
<publicattributes title=""/>
<publicstaticattributes title=""/>
<protectedtypes title=""/>
<protectedslots title=""/>
<protectedmethods title=""/>
Expand All @@ -67,6 +72,7 @@
<packagestaticmethods title=""/>
<packageattributes title=""/>
<packagestaticattributes title=""/>
<properties title=""/>
<events title=""/>
<privatetypes title=""/>
<privateslots title=""/>
Expand All @@ -75,6 +81,7 @@
<privateattributes title=""/>
<privatestaticattributes title=""/>
<friends title=""/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>
</memberdecl>
<memberdef>
Expand Down Expand Up @@ -103,6 +110,7 @@
<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=""/>
Expand All @@ -126,19 +134,29 @@
<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"/>
<includegraph visible="yes"/>
<includedbygraph visible="yes"/>
<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=""/>
Expand Down Expand Up @@ -166,12 +184,14 @@
<!-- Layout definition for a group page -->
<group>
<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<groupgraph visible="yes"/>
<memberdecl>
<nestedgroups visible="yes" title=""/>
<modules 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=""/>
Expand Down Expand Up @@ -213,6 +233,25 @@
<authorsection visible="yes"/>
</group>

<!-- Layout definition for a C++20 module page -->
<module>
<briefdescription visible="yes"/>
<exportedmodules visible="yes"/>
<memberdecl>
<concepts visible="yes" title=""/>
<classes visible="yes" title=""/>
<enums title=""/>
<typedefs title=""/>
<functions title=""/>
<variables title=""/>
<membergroups title=""/>
</memberdecl>
<detaileddescription title=""/>
<memberdecl>
<files visible="yes"/>
</memberdecl>
</module>

<!-- Layout definition for a directory page -->
<directory>
<briefdescription visible="yes"/>
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/QskCheckBox.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskCheckBox QskCheckBox.h

\embedWasm

\skinlet QskCheckBoxSkinlet
*/
7 changes: 7 additions & 0 deletions doc/classes/QskComboBox.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskComboBox QskComboBox.h

\embedWasm

\skinlet QskComboBoxSkinlet
*/
7 changes: 7 additions & 0 deletions doc/classes/QskDrawer.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskDrawer QskDrawer.h

\embedWasm

\skinlet QskDrawerSkinlet
*/
2 changes: 2 additions & 0 deletions doc/classes/QskLinearBox.dox
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/*!
\class QskLinearBox QskLinearBox.h

\embedWasm

\brief Layout stringing items in rows and columns

QskLinearBox organizes layout items in vertical or horizontal order
Expand Down
7 changes: 7 additions & 0 deletions doc/classes/QskPageIndicator.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskPageIndicator QskPageIndicator.h

\embedWasm

\skinlet QskPageIndicatorSkinlet
*/
7 changes: 7 additions & 0 deletions doc/classes/QskProgressBar.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskProgressBar QskProgressBar.h

\embedWasm

\skinlet QskProgressBarSkinlet
*/
7 changes: 7 additions & 0 deletions doc/classes/QskProgressRing.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskProgressRing QskProgressRing.h

\embedWasm

\skinlet QskProgressRingSkinlet
*/
7 changes: 7 additions & 0 deletions doc/classes/QskPushButton.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskPushButton QskPushButton.h

\embedWasm

\skinlet QskPushButtonSkinlet
*/
7 changes: 7 additions & 0 deletions doc/classes/QskRadioBox.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskRadioBox QskRadioBox.h

\embedWasm

\skinlet QskRadioBoxSkinlet
*/
7 changes: 7 additions & 0 deletions doc/classes/QskSegmentedBar.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskSegmentedBar QskSegmentedBar.h

\embedWasm

\skinlet QskSegmentedBarSkinlet
*/
5 changes: 5 additions & 0 deletions doc/classes/QskSimpleListBox.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/*!
\class QskSimpleListBox QskSimpleListBox.h

\embedWasm
*/
7 changes: 7 additions & 0 deletions doc/classes/QskSlider.dox
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*!
\class QskSlider QskSlider.h

\embedWasm

\skinlet QskSliderSkinlet
*/
2 changes: 2 additions & 0 deletions doc/classes/QskSpinBox.dox
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/*!
\class QskSpinBox QskSpinBox.h

\embedWasm

\brief A control to edit, increment and decrement number values

QskSpinBox allows the user to choose a value by:
Expand Down
Loading
Loading