GNU Info

(texinfo)Def Cmd Conventions

---

Next: Sample Function Definition Prev: Def Cmds in Detail Up: Definition Commands

---

Enter node , (file) or (file)node

Conventions for Writing Definitions
===================================

  When you write a definition using `@deffn', `@defun', or one of the
other definition commands, please take care to use arguments that
indicate the meaning, as with the COUNT argument to the `forward-word'
function.  Also, if the name of an argument contains the name of a
type, such as INTEGER, take care that the argument actually is of that
type.