Mercurial > hg > octave-nkf
comparison scripts/general/saveobj.m @ 10821:693e22af08ae
Grammarcheck documentation of m-files
Add newlines between @item fields for readability.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 26 Jul 2010 21:25:36 -0700 |
parents | 16f53d29049f |
children | fd0a3ac60b0e |
comparison
equal
deleted
inserted
replaced
10820:c44c786f87ba | 10821:693e22af08ae |
---|---|
21 ## Method of a class to manipulate an object prior to saving it to a file. | 21 ## Method of a class to manipulate an object prior to saving it to a file. |
22 ## The function @code{saveobj} is called when the object @var{a} is saved | 22 ## The function @code{saveobj} is called when the object @var{a} is saved |
23 ## using the @code{save} function. An example of the use of @code{saveobj} | 23 ## using the @code{save} function. An example of the use of @code{saveobj} |
24 ## might be to remove fields of the object that don't make sense to be saved | 24 ## might be to remove fields of the object that don't make sense to be saved |
25 ## or it might be used to ensure that certain fields of the object are | 25 ## or it might be used to ensure that certain fields of the object are |
26 ## initialized before the object is saved. For example | 26 ## initialized before the object is saved. For example: |
27 ## | 27 ## |
28 ## @example | 28 ## @example |
29 ## @group | 29 ## @group |
30 ## function b = saveobj (a) | 30 ## function b = saveobj (a) |
31 ## b = a; | 31 ## b = a; |