diff options
author | Stefan Radomski <github@mintwerk.de> | 2016-05-26 10:36:49 (GMT) |
---|---|---|
committer | Stefan Radomski <github@mintwerk.de> | 2016-05-26 10:36:49 (GMT) |
commit | 6e13c7b6e0888323223afd5d2e36e86243df57af (patch) | |
tree | f558fd45fa499c8bc95041554ecad6be1bf788c1 /docs | |
parent | f6714b1484b641ea61053350b7d156d2da760b8b (diff) | |
download | uscxml-6e13c7b6e0888323223afd5d2e36e86243df57af.zip uscxml-6e13c7b6e0888323223afd5d2e36e86243df57af.tar.gz uscxml-6e13c7b6e0888323223afd5d2e36e86243df57af.tar.bz2 |
Minor polishing for Java bindings and first draft of JEXL datamodel
Diffstat (limited to 'docs')
-rw-r--r-- | docs/DEVELOPERS.md | 8 | ||||
-rw-r--r-- | docs/Doxyfile.in | 12 | ||||
-rw-r--r-- | docs/DoxygenLayout.xml | 194 | ||||
-rwxr-xr-x | docs/bootstrap/customdoxygen.css | 34 | ||||
-rwxr-xr-x | docs/bootstrap/doxy-boot.js | 40 |
5 files changed, 281 insertions, 7 deletions
diff --git a/docs/DEVELOPERS.md b/docs/DEVELOPERS.md index 01e5792..4de9802 100644 --- a/docs/DEVELOPERS.md +++ b/docs/DEVELOPERS.md @@ -2,4 +2,10 @@ ## Getting Started -Did only work on structure and layout of documentation so far +When you [built SCXML](@ref building), you have three possibilities to work with SCXML state-charts: + +1. Embed the uSCXML interpreter in your program and parse and interpret state-chart documents at runtime. This allows for the most flexibility as the complete SCXML DOM is still available. + +2. Transpile SCXML state-charts onto one of the available target languages. These are currently VHDL and ANSI-C with C# and Java as likely additional targets. The benefit of this approach is the reduced footprint at runtime and fewer dependencies. + +3. Interpret SCXML documents directly with the `uscxml-browser`.
\ No newline at end of file diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index def8570..7a79a1d 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -109,7 +109,7 @@ BRIEF_MEMBER_DESC = YES # brief descriptions will be completely suppressed. # The default value is: YES. -REPEAT_BRIEF = YES +REPEAT_BRIEF = NO # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found @@ -564,7 +564,7 @@ SORT_MEMBER_DOCS = YES # this will also influence the order of the classes in the class list. # The default value is: NO. -SORT_BRIEF_DOCS = NO +SORT_BRIEF_DOCS = YES # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and @@ -576,7 +576,7 @@ SORT_BRIEF_DOCS = NO # detailed member documentation. # The default value is: NO. -SORT_MEMBERS_CTORS_1ST = NO +SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will @@ -689,7 +689,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = @PROJECT_SOURCE_DIR@/docs/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -847,7 +847,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = +EXAMPLE_PATH = @PROJECT_SOURCE_DIR@/test/src/ # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -861,7 +861,7 @@ EXAMPLE_PATTERNS = * # irrespective of the value of the RECURSIVE tag. # The default value is: NO. -EXAMPLE_RECURSIVE = NO +EXAMPLE_RECURSIVE = YES # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the diff --git a/docs/DoxygenLayout.xml b/docs/DoxygenLayout.xml new file mode 100644 index 0000000..c7e65b9 --- /dev/null +++ b/docs/DoxygenLayout.xml @@ -0,0 +1,194 @@ +<doxygenlayout version="1.0"> + <!-- Generated by doxygen 1.8.10 --> + <!-- Navigation index tabs for HTML output --> + <navindex> + <tab type="mainpage" visible="yes" title=""/> + <tab type="pages" visible="yes" title="" 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="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="filelist" visible="yes" title="" intro=""/> + <tab type="globals" visible="yes" title="" intro=""/> + </tab> + <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"/> + <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=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <inlineclasses title=""/> + <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=""/> + <constantgroups visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <inlineclasses title=""/> + <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> + <nestedgroups visible="yes" title=""/> + <dirs visible="yes" title=""/> + <files visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <classes 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/docs/bootstrap/customdoxygen.css b/docs/bootstrap/customdoxygen.css index 6c71e58..aa2c2bf 100755 --- a/docs/bootstrap/customdoxygen.css +++ b/docs/bootstrap/customdoxygen.css @@ -242,12 +242,35 @@ div.groupText { /* OWN */ +.table> tbody > .mdetail > td { + padding: 0px; + border-top: 0px; +} + +.table> tbody > .mdetail > td > div.panel { + border-radius: 0px; + box-shadow: none; + -webkit-box-shadow: none; + margin-bottom: 0px; + border: 0px; +} + +.table> tbody > .mdetail { + border: 1px solid #ddd; +} + + div.mbrief { padding: 0px 8px; margin: 5px 0px; border-left: 4px solid #DDD; } +.mdetail div.fragment { + margin-bottom: 15px; +} + + div.toc, div.toc li { font: 400 10px/22px Roboto, sans-serif; line-height: 1.2; @@ -410,11 +433,20 @@ span.SRScope { .table-hover; padding: 3px; /* border-bottom: 2px solid #e0e0e0;*/ + border-bottom: 0px; +} + +table.memname td.memname > a, +table.memname td.paramtype > a, +.table > tbody > tr > td.memItemLeft > a, +.table > tbody > tr > td.memItemRight > a { + font-weight: bold; } .table > tbody > tr > td.memItemLeft { border-top: 1px solid #e0e0e0; } + .table > tbody > tr > td.mdescRight { border-bottom: 1px solid #e0e0e0; } @@ -424,6 +456,8 @@ span.SRScope { .table > tbody > tr > td.memItemRight { border-left: 1px solid #e0e0e0; border-right: 1px solid #e0e0e0; + padding: 5px 8px; +/* line-height: 1.2;*/ /* width: auto;*/ } diff --git a/docs/bootstrap/doxy-boot.js b/docs/bootstrap/doxy-boot.js index 39c6a5d..6fe56b0 100755 --- a/docs/bootstrap/doxy-boot.js +++ b/docs/bootstrap/doxy-boot.js @@ -315,6 +315,46 @@ $( document ).ready(function() { $(this).parent().remove(); }); + /* Move detailled collapsible under brief */ + $('div.mbrief a').each(function(){ + var detailLink = $(this); + var detailAnchor = $(this).attr('href'); + + if ($(detailAnchor).length) { + + var detailContent = $(detailAnchor).next(); + detailContent.addClass("collapse"); + + $(this).removeAttr('href'); + + $(this).click(function() { + if (!$(detailContent).hasClass("in")) { + detailContent.addClass("in"); + $(detailLink).text("Less ..."); + } else { + detailContent.removeClass("in"); + $(detailLink).text("More ..."); + } + }); + + $(detailContent).find('.panel-heading').remove(); + + $(this).parent().parent().prev().append($(detailAnchor)); + // $(this).parent().parent().append($(detailContent)); + + $(this).parent().parent().parent() + .after("<tr>").next().addClass("mdetail") + .append("<td>").children('td:last').attr("colspan", "2") + .append($(detailContent)); + } + }); + + $('h2.groupheader').each(function(){ + if ($(this).text() == "Member Function Documentation") { + $(this).remove(); + } + }); + // $('.mdescLeft').each(function(){ // if($(this).html()==" ") { // $(this).siblings('.mdescRight').attr('colspan', 2); |