Change license name

[platform/upstream/gobject-introspection.git] / docs / gir-1.2.rnc

diff --git a/docs/gir-1.2.rnc b/docs/gir-1.2.rnc
index 6fa656c..64443f7 100644 (file)
--- a/docs/gir-1.2.rnc
+++ b/docs/gir-1.2.rnc
@@ -170,6 +170,8 @@ grammar {
       attribute abstract { "0" | "1" }?,
       ## Binary attribute to declare the class fundamental or not (top-level class which do not derives from any other type)
       attribute glib:fundamental { "0" | "1" }?,
+      ## Binary attribute to declare the class final or not (non-derivable class in a derivable hierarchy)
+      attribute final { "0" | "1" }?,
 
       # Other elements a class can contain
       (Info.elements
@@ -262,18 +264,18 @@ grammar {
       attribute xml:whitespace { "preserve" }?,
       ## the text of the version of the documentation
       text
-    }?
+    }? &
     ## give the stability of the documentation
-    & element doc-stability {
+    element doc-stability {
       ## Preserve the original formatting of the documentation from the source code
       attribute xml:space { "preserve" }?,
       ## Preserve the original formatting of the documentation from the source code. Recommended to use this instead of xml:space
       attribute xml:whitespace { "preserve" }?,
       ## a text value about the stability of the documentation. Usually a simple description like stable or unstable
       text
-    }?
+    }? &
     ## documentation of an element
-    & element doc {
+    element doc {
       ## Preserve the original formatting of the documentation from the source code
       attribute xml:space { "preserve" }?,
       ## Keep the whitespace as they were in the source code
@@ -286,24 +288,24 @@ grammar {
       attribute column { xsd:string },
       ## the text of the documentation
       text
-    }?
+    }? &
     ## Deprecated documentation of an element. Kept for historical reasons in general
-    & element doc-deprecated {
+    element doc-deprecated {
       ## Preserve the original formatting of the documentation from the source code
       attribute xml:space { "preserve" }?,
       ## Keep the whitespace as they were in the source code
       attribute xml:whitespace { "preserve" }?,
       ## the text of the deprecated documentation
       text
-    }?
+    }? &
     ## Position of the documentation in the original source code
-    & element source-position {
+    element source-position {
       ## File name of the source of the documentation
       attribute filename { xsd:string },
       ## The first line of the documentation in the source code
       attribute line { xsd:string },
       ## The first column of the documentation in the source code
-      attribute column { xsd:string },
+      attribute column { xsd:string }
     }?
   )
 
@@ -345,6 +347,10 @@ grammar {
       attribute construct { "0" | "1" }?,
       ## Binary attribute, true if the property can only be set upon construction
       attribute construct-only { "0" | "1" }?,
+      ## The setter function for this property
+      attribute setter { xsd:string }?,
+      ## The getter function for this property
+      attribute getter { xsd:string }?,
       # Define the transfer of ownership of the property element
       TransferOwnership?,
 
@@ -354,20 +360,20 @@ grammar {
     }
 
   Signal =
-    ## A signal as defined in the GObject system (https://developer.gnome.org/gobject/stable/signal.html)
+    ## A signal as defined in the GObject system (https://developer-old.gnome.org/gobject/stable/signal.html)
     element glib:signal {
       Info.attrs,
       ## name of the signal
       attribute name { xsd:string },
-      ## Binary attribute, true if the signal has a detailed parameter (https://developer.gnome.org/gobject/stable/signal.html#signal-detail# and https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags)
+      ## Binary attribute, true if the signal has a detailed parameter (https://developer-old.gnome.org/gobject/stable/signal.html#signal-detail and https://developer-old.gnome.org/gobject/stable/gobject-Signals.html#GSignalFlags)
       attribute detailed { "0" | "1" }?,
-      ## When to run the signal during the 5 steps of signal emission (https://developer.gnome.org/gobject/stable/signal.html#signal-emission and https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags)
+      ## When to run the signal during the 5 steps of signal emission (https://developer-old.gnome.org/gobject/stable/signal.html#signal-emission and https://developer-old.gnome.org/gobject/stable/gobject-Signals.html#GSignalFlags)
       attribute when { "first" | "last" | "cleanup" }?,
-      ## Binary attribute, true if the signal can be freely emitted on alive objects from user code (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags)
+      ## Binary attribute, true if the signal can be freely emitted on alive objects from user code (https://developer-old.gnome.org/gobject/stable/gobject-Signals.html#GSignalFlags)
       attribute action { "0" | "1" }?,
-      ## Binary attribute, true if no emission hooks are supported for this signal (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags) 
+      ## Binary attribute, true if no emission hooks are supported for this signal (https://developer-old.gnome.org/gobject/stable/gobject-Signals.html#GSignalFlags) 
       attribute no-hooks { "0" | "1" }?,
-      ## Binary attribute, true if signals emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted (https://developer.gnome.org/gobject/unstable/gobject-Signals.html#GSignalFlags)
+      ## Binary attribute, true if signals emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted (https://developer-old.gnome.org/gobject/stable/gobject-Signals.html#GSignalFlags)
       attribute no-recurse { "0" | "1" }?,
 
       # Other elements a property can contain
@@ -532,10 +538,10 @@ grammar {
 
         (DocElements
          & (AnyType | VarArgs))
-      }*
+      }* &
 
       ## instance-parameter is a parameter of a C function which is an instance of an existing object. So the callable is surely a method of a class, and this parameter points to the instance of the object. In C++, this would be equivalent to the pointer this which is not passed to the method, in Python it's equivalent to self.
-      & element instance-parameter {
+      element instance-parameter {
         ## name of the instance-parameter
         attribute name { xsd:string },
         ## Binary attribute, true if the parameter can have a null value
@@ -591,6 +597,11 @@ grammar {
     element method {
       Callable.attrs,
 
+      ## The GObject property that is set by this method
+      attribute glib:set-property { xsd:string }?,
+      ## The GObject property that is retrieved by this method
+      attribute glib:get-property { xsd:string }?,
+
       (Info.elements
        & Callable.params?
        & Callable.return?)
@@ -679,8 +690,10 @@ grammar {
       attribute value { xsd:string },
       ## corresponding C type of the member
       attribute c:identifier { xsd:string },
-      ## short nickname of the member
+      ## short nickname of the member (from GEnumValue/GFlagsValue)
       attribute glib:nick { xsd:string }?,
+      ## name of the member (from GEnumValue/GFlagsValue)
+      attribute glib:name { xsd:string }?,
 
       Info.elements
     }