Re: No method description displayed

[David Nečas <yeti@xxxxxxxxxxxxxxx>]

On Wed, Nov 30, 2011 at 05:28:20PM +0100, David Boesner wrote:
> I have a problem. I'm using gtk-doc to produce a documentation of my
> program.
> 
> My functions are documented like that :
> 
> /*
>  * GTspi_Context_Get_TPM_Context:
>  * @self: A GTspiContext
>  *
>  * This method returns the hContext of the GTspiContext
>  *
>  * Returns: The TSS_HCONTEXT
>  */
> 
> The text: "This method returns the hContext of the GTspiContext"
> is not displayed in my html-file produced by gtk-doc.
> 
> Can you please help me?

If this is the exact comment then it is not recognised by gtk-doc at
all.  The comments needs to look like

/**
 * GTspi_Context_Get_TPM_Context:
.* ..
 **/

Note the double asterisks that differeniate comments to be consumed by
gtk-doc from normal comments.

Yeti

_______________________________________________
gtk-list mailing list
gtk-list@xxxxxxxxx
http://mail.gnome.org/mailman/listinfo/gtk-list