Merge pull request #26 from Tolc-Software/docs

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.17)
 
 project(
   tolc
-  VERSION 0.4.1
+  VERSION 0.5.0
   LANGUAGES CXX)
 
 configure_file(docs/ReleaseNotes/version.in
@@ -31,17 +31,17 @@ include(${modules}/Sanitizers.cmake)
 include(${modules}/StaticAnalyzers.cmake)
 
 include(${modules}/GetFrontend.cmake)
-get_frontend(NAME Frontend.py VERSION latest)
+get_frontend(NAME Frontend.py VERSION v0.5.0)
 copy_frontend_docs(NAME Frontend.py SRC_DIR ${frontend.py_SOURCE_DIR} COPY_TO
                    ${CMAKE_CURRENT_LIST_DIR}/docs/packaging/docs/python)
 
-get_frontend(NAME Frontend.wasm VERSION latest)
+get_frontend(NAME Frontend.wasm VERSION v0.4.5)
 copy_frontend_docs(
   NAME Frontend.wasm SRC_DIR ${frontend.wasm_SOURCE_DIR} COPY_TO
   ${CMAKE_CURRENT_LIST_DIR}/docs/packaging/docs/webassembly)
 
 include(${modules}/GetParser.cmake)
-get_parser(VERSION v0.2.0)
+get_parser(VERSION v0.3.0)
 
 # Set the include path for the system library in the variable
 # We are using the standard library shipped

docs/ReleaseNotes/v0.5.0.md

@@ -0,0 +1,57 @@
+# News #
+
+## Bindings ##
+
+* Add support for transferring documentation from the C++ to pybind11
+  * Add tests for all officially supported documentation styles
+  * Supported for:
+    * Classes
+    * Member variables
+    * Enums
+    * Functions
+
+Example of documentation string styles:
+
+```cpp
+// One line comment
+class OneLiner {};
+
+/** Single multi line comment */
+class SingleMulti {};
+
+/**
+* Multi
+* line
+* comment
+*/
+class Multi {};
+
+/**
+Bare multi
+Another line
+*/
+class BareMulti {};
+
+/*!
+* Qt style
+*/
+class QtStyle {};
+
+/*******************************************************************************
+* JavaDoc Style
+* is
+* boxy
+******************************************************************************/
+class JavaDoc {};
+
+///
+/// Triplets is a commitment
+///
+class Triplets {};
+
+//!
+//! This is one of the doxy styles
+//!
+class DoxyBang {};
+```
+

docs/packaging/docs/webassembly/introduction.md

@@ -158,6 +158,7 @@ Assuming you've loaded the `javascript` within your page:
 ...
 ```
 
+For a complete example you can see the `Tolc-demo` repository: [https://github.com/Tolc-Software/tolc-demo](https://github.com/Tolc-Software/tolc-demo).
 
 If you want to see what more is supported you can take a look at [the Examples section](./examples.md).