Open main menu

Difference between revisions of "Code Formatting Conventions"

(some cleanup and typos)
(→‎Doxygen documentation comments: updated doxygen link)
Line 199: Line 199:
   */
   */
  virtual void warpMouse(int x, int y) = 0;
  virtual void warpMouse(int x, int y) = 0;
(view the generated documentation [http://scummvm.org/docs/doxygen/html/classOSystem.php#z7_1 here]).
(view the generated documentation [http://doxygen.scummvm.org/d9/df4/classOSystem.html#ecab84670def917107d6c1b5ca3b82c3 here]).


As shown in the example, documentation blocks also support several special commands such as '''param'''. Those are prefixed with either '''@''' or '''\''', but developers should always use '''@'''.
As shown in the example, documentation blocks also support several special commands such as '''param'''. Those are prefixed with either '''@''' or '''\''', but developers should always use '''@'''.
1,079

edits