Re: new documentation format

[Jody Goldberg <jody gnome org>]

On Tue, Nov 29, 2005 at 11:06:19AM -0500, Morten Welinder wrote:
> Just thinking about we might want to have something like:
>
>    { GNM_FUNC_HELP_EXAMPLE_1, "GCD(10,15)" }

That was the goal of
    GNM_FUNC_HELP_EXAMPLES,             /* <TEXT and EXAMPLES ?? get a hook to enter the sample ?? >    
(translated) */
It seems like we'd want a short comment and an expression.
    "Error Handling:=FOO(1/0)"
but it was unclear how to format it.

> That should be good enough for hundreds of functions.  It won't work for
> INDEX and other range-type functions.  This might work:
>
>    { GNM_FUNC_HELP_EXAMPLE_TABLE, "A1:42" }
>    { GNM_FUNC_HELP_EXAMPLE_TABLE, "A2:-1.14" }
>    { GNM_FUNC_HELP_EXAMPLE_TABLE, "A3:\"4\"" }
>    { GNM_FUNC_HELP_EXAMPLE_TABLE, "A4:=SUM(A1:A3)" }
>    { GNM_FUNC_HELP_EXAMPLE_TEXT, N_("Since SUM ignores string...")}

I was planning to go one step further and support shared tables.
char *content[] = {
    "content A1", "content B1",
    "content A2", "content B2",
    "content A3", "content B3"
};
gnm_func_doc_sample_register ("name", 2, 3, content);

Then have the function docs reference the named table.