add user base documentation

This commit is contained in:
Robin Müller 2022-08-09 15:51:01 +02:00
parent dce1ebcf65
commit 7a20412305
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC

View File

@ -7,6 +7,12 @@ namespace cfdp {
class UserBase {
public:
/**
* Create a user base class which is used to provides a user interface to interact with CFDP
* handlers. It is also used to pass the Virtual Filestore (VFS) Implementation to the CFDP
* handlers so the filestore operations can be mapped to the underlying filestore.
* @param vfs Virtual Filestore Object. Will be used for all file operations
*/
explicit UserBase(HasFileSystemIF& vfs);
private: