From b59b93d3943262cb66e3355e0c9ce0ea672ff196 Mon Sep 17 00:00:00 2001 From: jonas Date: Fri, 1 Feb 2019 13:38:52 +0100 Subject: Documentation --- cObject.h | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) (limited to 'cObject.h') diff --git a/cObject.h b/cObject.h index 87d0205..d0947da 100644 --- a/cObject.h +++ b/cObject.h @@ -12,14 +12,26 @@ struct sObject int sizeX; int sizeY; }; -/* cObject can be used standalone as well as inherited + +/** cObject can be used standalone as well as inherited * every cObject has its own framebuffer as well as position viariables to be moveable. -* cObject is used by cObjectHandler to manage all objects to be displayed +* cObject is used by cObjectHandler to manage all objects to be displayed. +* +* Minimal example for inheriting class +* +* +* class example : cObject +* { +* public: +* example() { setSize(10,5); } +* ~example() { destruct(); } +* }; +* */ class cObject : public cRender { public: - /* Sets the size to _sx x _sy + /** Sets the size to _sx x _sy */ cObject(int _sx, int _sy); -- cgit v1.2.3