• A Namespace

    • Contents

    A Namespace

    This is namespace A created to showcase doc generation. More...

    Header: #include <a.h>

    Namespaces

    namespace InnerNamespace

    Classes

    class Base
    class Extreme
    class Foo
    class SubClassA
    class SubClassB
    class SubClassC
    class SubClassD
    class TemplateClass

    Types

    enum GlobalEnum { Hello, World }
    typedef ThisIsATypedef

    Variables

    int VariableInNamespaceA2
    int VariableInNamespaceA
    const bool thisIsAVariable
    int thisIsAnotherVariable

    Functions

    void globalFunction__()
    T globalTemplateFunction(const T & xyz)
    std::ostream & operator<<(std::ostream & o, const Foo & foo)

    Macros

    void MACRO_2( a, x)

    Detailed Description

    This is namespace A created to showcase doc generation.

    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    Maybe a new paragraph would be also nice. This filling-text doesn't have to make sense. It joust should be a lot of it. In this case, I prefer Quantity over Quality. That's usually not a good idea when writing a documentation. But for a showcase I think this should be ok.

    Is it already eneough filltext? I don't think so. I need more! But where can I get some ideas for a text? I have no idea. Maybe I should tell something about my past. Well there was an apple cake my grandma used to bake. Maybe I should search the recipe? It had a lot of of fruit, so I don't think it was very unhealthy. I think it's time of a linebreak.
    Now, that we are already talking about cokkies: Have you ever wondert, why there are some sortsof candy you can only buy for special holidays like christmas. While there are other sorts of cookies you can buy the whole year. I wonder who decided to sell some cookies only for certain holidays. Hmm, probably it wasn't a decision of a single person. It was was a tradicion for some cookies. But then, chockolate, coconuts and vanilla were unknown in europe for centuries. So the tradition must have evolved in the past few centuries.

    Well, I think that's eneough text for now. I probably will copy this text, even if it has no meaning for anyone. But hey, that's the idea of it.

    Namespaces

    namespace A::InnerNamespace

    This is a namespace within another namespace

    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    Maybe a new paragraph would be also nice. This filling-text doesn't have to make sense. It joust should be a lot of it. In this case, I prefer Quantity over Quality. That's usually not a good idea when writing a documentation. But for a showcase I think this should be ok.

    Classes

    class Base

    This is the Base class of the Extreme class. More...

    class Extreme

    This is a class containg a lot. More...

    class Foo

    This a brief description for the class A::Foo More...

    class SubClassA

    This is the SubClassA More...

    class SubClassB

    This is the SubClassB Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text. More...

    class SubClassC

    This is the SubClassC More...

    class SubClassD

    This is the SubClassD More...

    class TemplateClass

    This is the TemplateClass More...

    Type Documentation

    enum A::GlobalEnum

    This the docu for the enum GlobalEnum

    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    ConstantValueDescription
    A::Hello0Hi there
    A::World1So round ans blue

    typedef A::ThisIsATypedef

    This a typedef ThisIsATypedef

    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    Variable Documentation

    int A::VariableInNamespaceA2

    This variable holds documentation for variable VariableInNamespaceA2.

    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    int A::VariableInNamespaceA

    This variable holds documentation for variable VariableInNamespaceA.

    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    const bool A::thisIsAVariable

    This variable holds this a variable thisIsAVariable.

    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    int A::thisIsAnotherVariable

    This variable holds this another variable thisIsAnotherVariable.

    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    Function Documentation

    void A::globalFunction__()

    This the global function globalFunction__ of the Base class

    This the docu for globalFunction.
    Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    T A::globalTemplateFunction(const T & xyz)

    This the docu for globalTemplateFunction

    This has an xyz argument. Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    std::ostream & A::operator<<(std::ostream & o, const Foo & foo)

    This is an overloaded operator for printing values

    This has an rgumentd o and another foo. Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.

    Macro Documentation

    void MACRO_2( a, x)

    This is a macro MACRO_2

    It has two arguments a and x. Some other text. To be able to get a feeling for text formating, you need a lot of text to get a feeling for it. So yeah, tadaa! Here's some text. I thnk we need a little more text. A lot more text.