Sign up

Meaning of '@' in the GTK Docs

Hi Mike,

This is embarrassing. I must have dozed off when the @ symbol came into common use. I keep seeing references to @argc, @argv, @name, etc. scattered throughout the wrapper code comments. I'm having no luck with a Google search.

So, my question is: What does the @ symbol mean when used this way?

Re: Meaning of '@' in the GTK Docs

On Sat, 11 Apr 2020 08:31:47 GMT, Ron Tarrant wrote:

So, my question is: What does the @ symbol mean when used this way?

It's got something to do with documentation?

Re: Meaning of '@' in the GTK Docs

On Sat, 11 Apr 2020 08:56:48 GMT, Ron Tarrant wrote:

It's got something to do with documentation?

Okay, I think I've got it now. The '@,' along with other symbols such as '%' and '#' are directives used by GtkDoc to generate documentation from code file comments.

Please correct me if I'm going off in the wrong direction here.

Re: Meaning of '@' in the GTK Docs

On 11-04-2020 11:35, Ron Tarrant wrote:

On Sat, 11 Apr 2020 08:56:48 GMT, Ron Tarrant wrote:

It's got something to do with documentation?

Okay, I think I've got it now. The '@,' along with other symbols such as '%' and '#' are directives used by GtkDoc to generate documentation from code file comments.

Please correct me if I'm going off in the wrong direction here.

Yes they are from the C documentation / Gtk-Doc, @ denotes parameters
and % i believe denotes types like TRUE, FALSE, and NULL.

adrdox understands most of these so they shouldn't show up in the online
documentation.

Re: Meaning of '@' in the GTK Docs

On Sat, 11 Apr 2020 12:37:52 +0200, Mike Wey wrote:

Yes they are from the C documentation / Gtk-Doc, @ denotes parameters
and % i believe denotes types like TRUE, FALSE, and NULL.

adrdox understands most of these so they shouldn't show up in the online
documentation.

Thanks, Mike.