Browse Source

more details. :-)

master
roker 1 year ago
parent
commit
dc58044ebe
1 changed files with 8 additions and 1 deletions
  1. +8
    -1
      README.md

+ 8
- 1
README.md View File

@ -7,4 +7,11 @@
* always initialize all members. Better safe than sorry.
* Ownership of the member pointees: rule of thumb: "const" pointees are non-owned, non-const pointees are owned by the data structure. Exceptional cases are documented explicitly.
## API
## Public API
* defined in `namespace pEp` – Beware: it is shared with libpEpAdapter!)
* header files are installed in `PREFIX/include/pEp/` and are used via `#include <pEp/filename.hh>` – (Also shared with libpEpAdapter!)
* the linked list datatypes implement the API of [`std::forward_list`](https://en.cppreference.com/w/cpp/container/forward_list)
## Implementation details
* internal stuff is in `namespace pEp::datatypes`

Loading…
Cancel
Save