howToDocument_IDL Class Reference

howToDocument_IDL IDL Interface to how-to-document-modules services. More...

#include <howToDocument_IDL.h>

Inherits Wire.

Inherited by FakeModule.

Public Member Functions
virtual bool	exampleService ()
	This an example service that just prints a sentence. More...
virtual bool	read (yarp::os::ConnectionReader &connection)
virtual std::vector< std::string >	help (const std::string &functionName="--all")

Detailed Description

howToDocument_IDL IDL Interface to how-to-document-modules services.

This is a fake thrift service, just to show how to structure your repo and how to document your code.

Definition at line 19 of file howToDocument_IDL.h.

Member Function Documentation

exampleService()

virtual bool howToDocument_IDL::exampleService ( )

virtual

This an example service that just prints a sentence.

Put here meaningful information about input/output parameters.

Returns

true

---

The documentation for this class was generated from the following file:

• /home/runner/work/how-to-document-modules/how-to-document-modules/gh-pages/idl_dox/howToDocument_IDL.h