Skip to content

Commit

Permalink
added deque to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sami-Vuorela committed Mar 15, 2016
1 parent 9e9fd1c commit 046c3b0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -5,6 +5,7 @@ Bringing over your good old friends, the STL containers from c++ to angelscript.
Currently these container types are supported:
* vector
* list
* deque
* set
* unordered_set
* map
Expand Down
3 changes: 1 addition & 2 deletions documentation/doc_extra_input/mainpage.dox
Expand Up @@ -4,6 +4,7 @@
<p>These container types are provided:</p>
- vector
- list
- deque
- set
- unordered_set
- map
Expand All @@ -27,6 +28,4 @@
- \subpage page_manual_requirements
- \subpage page_manual_installation
- \subpage page_manual_usage
<p>The actual doxygen class list on the left probably isn't very useful because it only tells you about the c++ implementation, which is an abomination made up of templates of templates of stl templates. If you are looking for the script interface, you can find it here \ref page_manual_usage_script_interface</p>

*/
Expand Up @@ -3,6 +3,7 @@
<p>You can only register template specializations for these containers:</p>
- vector
- list
- deque
- set
- unordered_set
<p>map and unordered_map are not available because they take 2 template parameters and that would require partial template specialization which angelscript probably doesnt support.</p>
Expand All @@ -15,11 +16,14 @@
- list
- operator equals
- operator less
- deque
- operator equals
- operator less
- set
- operator less
- unordered_set
- operator equals
- meta operator hash
- pseudo-operator hash

<p>Hash is not an operator, but a functor by name of aatc::hash::hashfunctor</p>
See: \ref page_manual_usage_registration_hash for all your hashing needs
Expand All @@ -32,6 +36,8 @@ See: \ref page_manual_usage_registration_hash for all your hashing needs
aatc::container::tempspec::vector<MyCppClass>::Register(engine, "MyCppClass_name_in_script");
\endcode
\n
<p>Warning: You should not register MyCppClass* as a tempspec. If you want to store handles, you should use a templated container instead.</p>
\n
\par Examples
<p>Registering a template specialization of the class "myVec3" for the containers vector and list:</p>
\code{.cpp}
Expand Down

0 comments on commit 046c3b0

Please sign in to comment.