Re: Contributing m-files to the image package

[Michael D. Godfrey]

On 12/24/2013 02:11 AM, Wang S wrote:
> Hi Brandon,
>
> by "to generate documentation for individual .m file" do you mean the "help 
> text" of .m file?
> The OctaveForge package named "generate_html" can generate it for individual .m 
> file as html format.
> Sometimes I just simply use octave help command + shell for-loop + output 
> redirection to generate help text for individual .m file as plain text format.
> Is this that you want to generate?
>
> Best regards,
> Wang S
>   
> ------------------ Original ------------------
> From:  "Brandon Miles"<address@hidden>;
> Date:  Sat, Dec 21, 2013 03:32 AM
> To:  "octave-maintainers"<address@hidden>;
> Subject:  Contributing m-files to the image package
>   
> Hi everyone,
>
> I have a background in image processing and I'd like contribute to octave 
> developement.
>
> I wasn't able to figure this out myself.  Is it possible to generate 
> documentation for individual .m file?
>
> Thanks,
>
> Brandon
Or, if you want to see how to create the text for documentation and 
help, look for ## -*- texinfo -*-
in most any .m file such as line 19 of:
scripts/linear-algebra/orth.m
You will need to learn the basics of texinfo to write this 
documentation. On linux systems man texinfo or info texinfo
is a place to start. Otherwise look on the web at 
http://www.gnu.org/software/texinfo/.

Michael