Adobe Systems Incorporated

A one-line synopsis of what the class does. More...

#include <class_template.hpp>

List of all members.

Public Types

typedef int my_associated_type_t

Public Member Functions

 my_class_t ()
adobe::my_return_t my_function (const adobe::my_parameter_t &a, const adobe::my_parameter_t &b)

Public Attributes

my_associated_type_t my_variable_m

Related Functions

(Note that these are not member functions.)

adobe::my_return_t related_non_member_function ()

Detailed Description

This is the location of a greater description of this class. Please note that as you instantiate this template for documenting your own classes, you will need to change the group to which the class belongs from asl_documentation_templates to something else (most likely asl_libraries.)

Model Of:
  • List all concepts this type models
Template Parameters:
What are the class' template parameters? What concepts (if any) do they model?
What other solutions exist in this domain? Why were they rejected over the creation of this class?
        #include <adobe/my_class_t.hpp>

        my_class_t my_class;

See Also:
Is there any other related documentation of which readers of this type's documentation should be made aware?

Definition at line 3 of file class_template.hpp.

Member Typedef Documentation

This is the documentation for a typedef declared within my_class_t.

Definition at line 6 of file class_template.hpp.

Constructor & Destructor Documentation

my_class_t (  )

Default constructor. See DefaultConstructible.

Member Function Documentation

adobe::my_return_t my_function ( const adobe::my_parameter_t &  a,
const adobe::my_parameter_t &  b 

A one-line synopsis of this member function.

This is a more extended description of the member function. Please note that any and all types (including the class type) must be fully qualified in the fn Doxygen command above in order for Doxygen to match it with the correct C++ code. Also please note the complete function declaration must be on one line for the fn Doxygen command to parse it correctly.

What are the preconditions required for this function?
aThis is the documentation for the first parameter
bThis is the documentation for the second parameter
The type of the return value is obvious, so what does it contain or do?
What are the postconditions guaranteed for this function?
std::my_exception_tThrown when you instantiate this object.
Are there any other miscellaneous notes for this function?

Friends And Related Function Documentation

adobe::my_return_t related_non_member_function (  ) [related]

A one-line synopsis of this member function.

This function is somehow related to adobe::my_class_t, but isn't a member function for the class itself.

Member Data Documentation

This is documentation of the member variable within my_class_t

Definition at line 13 of file class_template.hpp.

Copyright © 2006-2007 Adobe Systems Incorporated.

Use of this website signifies your agreement to the Terms of Use and Online Privacy Policy.

Search powered by Google