octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Recommended practice for class help texts


From: Søren Hauberg
Subject: Recommended practice for class help texts
Date: Sun, 28 Mar 2010 21:12:08 -0700

Hi All

I'm slowly beginning to use the object oriented programming stuff in
Octave, and now I am left wondering...

When I create a class and provide implementations of a common function,
say 'disp', how should I write the documentation? Should I write

  @deftypefn{Function File} disp (@var{a})
  ...

or should I write

  @deftypefn{Function File} @@myclass/disp (@var{a})

? That is, should I write the class name in front of the function name
or is it better to leave it out? What should be the recommended
practice?

Soren



reply via email to

[Prev in Thread] Current Thread [Next in Thread]