gir icon indicating copy to clipboard operation
gir copied to clipboard

Add properties to docs

Open Hofer-Julian opened this issue 3 years ago • 5 comments

Gir currently adds an "Implements" section to the docs (e.g. see here)

To me it would make sense to add a "Properties" section as well. After a quick look it seems like most pieces already seem to be in place for that.

Unless anything speaks against it, I'd like to work on it.

Hofer-Julian avatar Mar 20 '21 19:03 Hofer-Julian

One counter point: GObjects like GtkWindow have many properties https://gnome.pages.gitlab.gnome.org/gtk/gtk4/class.Window.html#properties

Hofer-Julian avatar Mar 20 '21 19:03 Hofer-Julian

@bilelmoussaoui @Hofer-Julian sir link is broken in first post.

ps-19 avatar Apr 10 '22 12:04 ps-19

can you please mention steps to remove this issue. I don't want to take any strain as i have lot of works related to college, internship.

ps-19 avatar Apr 10 '22 12:04 ps-19

One counter point: GObjects like GtkWindow have many properties https://gnome.pages.gitlab.gnome.org/gtk/gtk4/class.Window.html#properties

You can always wrap the properties in a <details> tag. It would like this:

Properties

Click to see the list of properties
  • list
  • of
  • properties

GuillaumeGomez avatar Apr 10 '22 12:04 GuillaumeGomez

can you please mention steps to remove this issue. I don't want to take any strain as i have lot of works related to college, internship.

The idea is to modify the generated docs (see src/codgen/docs) to make it generate a list of the properties/signals.

bilelmoussaoui avatar Apr 10 '22 13:04 bilelmoussaoui