Skip to content

Commit a25ddbb

Browse files
Update documentation.
1 parent e300d40 commit a25ddbb

File tree

3 files changed

+403
-25
lines changed

3 files changed

+403
-25
lines changed

RESTProcess_base.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ namespace classdesc
4848
getClassdescObjectImpl(T& obj) {return nullptr;}
4949
public:
5050
virtual ~RESTProcessBase() {}
51-
/// perform the REST operation, with \a remainder being the query string and \a arguments as body text
51+
/// perform the REST operation, with \a path being the path string and \a arguments as body text
5252
/// result of operation is returned as an object, and can be serialised into REST_PROCESS_BUFFER using asBuffer
53-
virtual RPPtr process(const string& remainder, const REST_PROCESS_BUFFER& arguments)=0;
53+
virtual RPPtr process(const string& path, const REST_PROCESS_BUFFER& arguments)=0;
5454
virtual REST_PROCESS_BUFFER asBuffer() const=0;
5555
/// return signature(s) of the operations
5656
virtual std::vector<Signature> signature() const=0;
@@ -64,7 +64,7 @@ namespace classdesc
6464
template <class F> Signature functionSignature() const;
6565
/// returns a pointer to the underlying object if it is one of type T, otherwise null
6666
template <class T> T* getObject();
67-
/// @{ returns a classdesc object is referring to an object derived from classdesc::object
67+
/// @{ returns a classdesc object if referring to an object derived from classdesc::object
6868
virtual object* getClassdescObject() {return nullptr;}
6969
virtual const object* getConstClassdescObject() {return nullptr;}
7070
/// @}

0 commit comments

Comments
 (0)