From 3301430c676e4af6b95d96b6408a66f9d2768653 Mon Sep 17 00:00:00 2001 From: Minijackson Date: Sun, 8 Sep 2019 16:15:46 +0200 Subject: First version --- res/sample-markdown-project-1/main.cpp | 200 +++++++++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) create mode 100644 res/sample-markdown-project-1/main.cpp (limited to 'res/sample-markdown-project-1/main.cpp') diff --git a/res/sample-markdown-project-1/main.cpp b/res/sample-markdown-project-1/main.cpp new file mode 100644 index 0000000..8a892a2 --- /dev/null +++ b/res/sample-markdown-project-1/main.cpp @@ -0,0 +1,200 @@ +#include + +/// A sample namespace +/// +/// This is an extended +/// description of this +/// sample namespace. +/// +/// ```cpp +/// std::cout << "Example code" << std::endl; +/// ``` +namespace sample_namespace { + + /// A sample static variable + /// + /// This is an extended + /// description of this + /// static variable. + static int VARIABLE = 42; + + /// A nested namespace + /// + /// This is an extended + /// description of this + /// nested namespace. + namespace nested_namespace { + } + +} + +/// A sample class +/// +/// This is an extended +/// description of this +/// sample class. +class Sample { +public: + + /// \brief A public type + /// + /// This is an extended description of this typedef. + using Blabla = int; + + /// A sample inner class. + /// + /// This is an extended description of this sample inner class. + /// + /// We have a reference to the class Sample. + /// + /// Also a [link](#bla) + /// + /// And inline code: + /// + /// ```cpp + /// auto a = int{}; + /// ``` + class InnerClass { + /// A sample attribute. + /// + /// This is an extended description of this sample attribute, + void* sample_attribute; + }; + + /// A sample inner struct. + /// + /// This is an extended description of this sample inner struct. + struct InnerStruct { + /// A sample attribute. + /// + /// This is an extended description of this sample attribute. + void* sample_attribute; + }; + + /// A sample inner struct. + /// + /// This is an extended description of this sample inner struct. + enum InnerEnum { + /// A sample variant. + /// + /// This is an extended description of this sample variant, + SAMPLE_VARIANT1, + + /// Another sample variant. + /// + /// This is an extended description of this sample variant, + SAMPLE_VARIANT2, + + /// Another other sample variant. + /// + /// This is an extended description of this sample variant, + SAMPLE_VARIANT3, + }; + + + /// A sample method. + /// + /// This is an extended description of this sample method. + /// + /// # Parameters + /// + /// - `param1` is an input parameter + /// - `param2` is an input parameter + /// - `param3` is an input parameter + /// + /// # Preconditions + /// + /// - A precondition. + /// + /// # Preconditions + /// + /// - A postcondition. + int sample_method(char param1, std::string param2) const; + + /// A sample static function. + /// + /// This is an extended description of this sample static function. + static int sample_static_func(char param1, std::string param2); + +protected: + + /// A sample protected method. + /// + /// This is an extended description of this sample protected method. + int sample_protected_method(char param1, std::string param2) const; + +private: + + /// A sample attribute. + /// + /// This is an extended description of this sample attribute, + void* sample_attribute1; + + /// Another sample attribute. + /// + /// This is an extended description of this sample attribute, + InnerClass sample_attribute2; + + /// Another other sample attribute. + /// + /// This is an extended description of this sample attribute, + InnerStruct sample_attribute3; + + /// Another other other sample attribute. + /// + /// This is an extended description of this sample attribute, + InnerEnum sample_attribute4; + +}; + +/// A sample function. +/// +/// This is an extended description of this sample function. +/// +/// # Parameters +/// +/// - `param1` is an input parameter +/// - `param2` is an input parameter +/// - `param3` is an input parameter +/// +/// # Preconditions +/// +/// - A precondition. +/// +/// # Preconditions +/// +/// - A postcondition. +int sample_function(char param1, std::string param2, int hello_world) { + std::cout << helloworld << std::endl; +} + +/// Another sample function. +/// +/// This is an extended description of this sample function. +/// +/// # Preconditions +/// +/// - A precondition. +/// +/// # Preconditions +/// +/// - A postcondition. +int another_sample_function( + /// Documentation of param1 + char param1, + /// Documentation of param2 + std::string param2, + /// Documentation of hello_world + int hello_world +) { + std::cout << helloworld << std::endl; +} + +int main(int argc, char** argv) { + std::cout << "Hello World" << std::endl; + std::cout << arga << std::endl; +} + +int add(float a, float b) { return a + b; } +template struct A { typedef T::U dependent; }; +struct Integer { int i; }; Integer i = { i: 0 }; -- cgit v1.2.3