eive/fsfw
eive
/
fsfw
forked from fsfw/fsfw
14
1
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

A few typos and more docu

This commit is contained in:
Steffen Gaisser 2020-09-30 14:38:46 +02:00
parent aeeef53508
commit 2f61bd0a0f
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
container/PlacementFactory.h
View File

@ -5,16 +5,16 @@
#include <utility>
/**
* The Placement Factory is used to create objects at runtime in a specific pool.
* In general this should be avoided and is should only be used if you know what you are doing.
* In general, this should be avoided and it should only be used if you know what you are doing.
* You are not allowed to use this container with a type that allocates memory internally like ArrayList.
*
* You have to check the returned pointer against nullptr!
* Also, you have to check the returned pointer in generate against nullptr!
*
* A backend of Type StorageManagerIF must be given as a place to store the new objects.
* Therefore ThreadSafety is only provided by your StorageManager Implementation.
*
* Objects must be destroyed by the user with "destroy"! Otherwise the pool will not be cleared.
*
*
*
* The concept is based on the placement new operator.
*
* @warning Do not use with any Type that allocates memory internally!