docs: nicer formatting of the NULL keyword, everywhere

This commit is contained in:
Xavi Artigas 2019-09-10 16:05:44 +02:00
parent 08e5b09d0a
commit 96d8b9bc3e
26 changed files with 37 additions and 37 deletions

View File

@ -15,7 +15,7 @@ class @beta Ecore.Event.Message extends Efl.Loop_Message
}
data_steal {
[[ Steal the data out and set internal values to -1
for type and NULL for other vals ]]
for type and $NULL for other vals ]]
params {
@out type: int; [[ The event type ]]
@out data: void_ptr; [[ The event data ]]

View File

@ -147,7 +147,7 @@ class @beta Efl.Io.Copier extends Efl.Loop_Consumer implements Efl.Io.Closer {
If @.source is flagged "eos" and all data is written to the
destination then the "done" event is emitted.
If the destination is not set (ie: NULL) then data is kept
If the destination is not set (ie: $NULL) then data is kept
in a internal @Eina.Binbuf, which can be stolen with
@.binbuf_steal once "data" or "line" events are
emitted. It exists as a useful shortcut to easily drain

View File

@ -89,7 +89,7 @@ abstract @beta Ecore.Audio extends Efl.Object
data: void_ptr; [[User data to pass to the VIO functions]]
free_func: efl_key_data_free_func; [[This function takes care to
clean up $data when he VIO is
destroyed. NULL means do
destroyed. $NULL means do
nothing.
]]
}

View File

@ -74,7 +74,7 @@ interface @beta Efl.Net.Dialer extends Efl.Net.Socket {
'http'.
Whenever appropriate dialers may use system proxy if the
proxy is NULL (the default). To forcefully disable
proxy is $NULL (the default). To forcefully disable
proxy, use an empty string ("").
- http://username:password\@proxyserver:port
@ -91,7 +91,7 @@ interface @beta Efl.Net.Dialer extends Efl.Net.Socket {
get { }
set { }
values {
proxy_url: string; [[May be empty or NULL to unset]]
proxy_url: string; [[May be empty or $NULL to unset]]
}
}

View File

@ -31,7 +31,7 @@ class @beta Efl.Net.Dialer_Http extends Efl.Loop_Consumer implements Efl.Net.Dia
To enable debugging use EINA_LOG_LEVELS=ecore_con:4 environment
variable.
If the proxy is NULL (default), then the system proxy will be
If the proxy is $NULL (default), then the system proxy will be
used. On UNIX that's the environment variable $http_proxy (or
'$all_proxy') is used if the given address doesn't match
$no_proxy patterns. To disable proxy use an empty string. If
@ -259,7 +259,7 @@ class @beta Efl.Net.Dialer_Http extends Efl.Loop_Consumer implements Efl.Net.Dia
Since multiple requests can occur if @.allow_redirects
is true, then all headers will be accumulated. To know
when a new request's been started, check for headers with keys
being NULL. The value will be the "HTTP/VERSION RESPONSE"
being $NULL. The value will be the "HTTP/VERSION RESPONSE"
string received from the host, such as:
- key=NULL, value="HTTP/1.1 302 Found"
@ -381,7 +381,7 @@ class @beta Efl.Net.Dialer_Http extends Efl.Loop_Consumer implements Efl.Net.Dia
params {
epochtime: int64; [[UNIX Epoch time - seconds since 1/1/1970]]
}
return: mstring @move @no_unused; [[Newly allocated null-terminated string on success or NULL on errors]]
return: mstring @move @no_unused; [[Newly allocated null-terminated string on success or $NULL on errors]]
}
}

View File

@ -4,12 +4,12 @@ class @beta Efl.Net.Dialer_Ssl extends Efl.Net.Socket_Ssl implements Efl.Net.Dia
This creates an internal @Efl.Net.Dialer_Tcp and once connected
it will start the SSL handshake.
If the proxy is NULL (default), then the system proxy will be
If the proxy is $NULL (default), then the system proxy will be
used. On UNIX that's the environment variable $socks_proxy (or
'$proxy' or '$all_proxy') is used if the given address doesn't
match $no_proxy patterns. To disable proxy use an empty string.
If the proxy is NULL (default), then the system proxy will be
If the proxy is $NULL (default), then the system proxy will be
used. On UNIX that's the environment variable $socks_proxy (or
'$all_proxy') is used if the given address doesn't match
$no_proxy patterns. To disable proxy use an empty string. If

View File

@ -1,12 +1,12 @@
class @beta Efl.Net.Dialer_Tcp extends Efl.Net.Socket_Tcp implements Efl.Net.Dialer {
[[Connects to a remote TCP server.
If the proxy is NULL (default), then the system proxy will be
If the proxy is $NULL (default), then the system proxy will be
used. On UNIX that's the environment variable $socks_proxy (or
'$proxy' or '$all_proxy') is used if the given address doesn't
match $no_proxy patterns. To disable proxy use an empty string.
If the proxy is NULL (default), then the system proxy will be
If the proxy is $NULL (default), then the system proxy will be
used. On UNIX that's the environment variable $socks_proxy (or
'$all_proxy') is used if the given address doesn't match
$no_proxy patterns. To disable proxy use an empty string. If

View File

@ -52,7 +52,7 @@ class @beta Efl.Net.Dialer_Websocket extends Efl.Loop_Consumer implements Efl.Ne
not a subclass and thus not all HTTP features are exposed as the
WebSocket has strict requirements that must be respected.
If the proxy is NULL (default), then the system proxy will be
If the proxy is $NULL (default), then the system proxy will be
used. On UNIX that's the environment variable $http_proxy (or
'$all_proxy') is used if the given address doesn't match
$no_proxy patterns. To disable the proxy use an empty string. If

View File

@ -85,7 +85,7 @@ class @beta Efl.Net.Ip_Address extends Efl.Object {
params {
numeric_address: string; [[The numeric address to parse, such as '127.0.0.1:1234' or '[::1]:1234']]
}
return: Efl.Net.Ip_Address @move; [[The new IP address object or NULL if it failed to parse]]
return: Efl.Net.Ip_Address @move; [[The new IP address object or $NULL if it failed to parse]]
}
resolve @static {

View File

@ -34,10 +34,10 @@ class @beta Efl.Net.Session extends Efl.Loop_Consumer {
Some platforms may not implement the backend for this class. In
this cases the system will report always @.state "online"
(@Efl.Net.Session_State.online) and other properties will be
NULL, such as @.network_name, @.interface, @.ipv4 and @.ipv6; as well as
$NULL, such as @.network_name, @.interface, @.ipv4 and @.ipv6; as well as
@.technology is set to @Efl.Net.Session_Technology.unknown. As such
if you need to detect for an actual backend, check if the
state is online but those properties are NULL or technology is
state is online but those properties are $NULL or technology is
unknown.
Note: the @.connect method is subject to backend policy. For
@ -92,7 +92,7 @@ class @beta Efl.Net.Session extends Efl.Loop_Consumer {
Note: if there is no backend for this class, then state
will be always online, however @.technology will be
unknown, @.interface, @.network_name, @.ipv4 and @.ipv6 will be
NULL.
$NULL.
]]
get { }
values {

View File

@ -37,8 +37,8 @@ class @beta Efl.Net.Socket_Ssl extends Efl.Loop_Consumer implements Efl.Net.Sock
return: bool(false); [[$true if adopted, $false otherwise]]
}
values {
efl_net_socket: Efl.Net.Socket; [[The adopted object, if any, otherwise NULL]]
ctx: Efl.Net.Ssl.Context; [[The SSL context used when adopting the socket, if any, otherwise NULL]]
efl_net_socket: Efl.Net.Socket; [[The adopted object, if any, otherwise $NULL]]
ctx: Efl.Net.Ssl.Context; [[The SSL context used when adopting the socket, if any, otherwise $NULL]]
}
}
@ -68,7 +68,7 @@ class @beta Efl.Net.Socket_Ssl extends Efl.Loop_Consumer implements Efl.Net.Sock
address but the server certificate only specifies DNS
(names).
If NULL, then it will fetch from socket using
If $NULL, then it will fetch from socket using
@Efl.Net.Socket.address_remote or
@Efl.Net.Dialer.address_dial.

View File

@ -115,7 +115,7 @@ class @beta Efl.Net.Ssl.Context extends Efl.Object {
This is useful to avoid replicating a hostname in all
socket wrapper with hostname_override.
If NULL, then sockets wrappers will will fetch from
If $NULL, then sockets wrappers will will fetch from
adopted socket using address_remote or
address_dial.

View File

@ -75,7 +75,7 @@ mixin @beta Efl.Gfx.Color_Class
the third is the text shadow. (Note that the second two only apply
to text parts).
Returns NULL if the color class cannot be fetched.
Returns $NULL if the color class cannot be fetched.
Note: These color values are expected to be premultiplied by $a.]]
}

View File

@ -131,7 +131,7 @@ class @beta Efl.Io.Buffer extends Efl.Object
The returned memory must be freed with eina_binbuf_free().
On failure, for example a read-only backing store was
adopted with @.adopt_readonly, NULL is returned.
adopted with @.adopt_readonly, $NULL is returned.
]]
return: ptr(Eina.Binbuf) @move @no_unused; [[Binbuf]]
}

View File

@ -435,7 +435,7 @@ mixin @beta Efl.Access.Object requires Efl.Object
relationship_remove @beta {
[[Removes the relationship between two accessible objects.
If relation_object is NULL function removes all relations
If relation_object is $NULL function removes all relations
of the given type.
]]
params {

View File

@ -46,9 +46,9 @@ abstract @beta Efl.Ui.Item extends Efl.Ui.Layout_Base implements Efl.Ui.Selectab
@property item_parent {
[[The parent of the item.
This property expresses a tree structure of items. If the parent is NULL the item is added to
This property expresses a tree structure of items. If the parent is $NULL the item is added to
the root level of the content. The item parent can only be set once.
When the object is invalidated, the item parent is set to NULL and still cannot be reset.
When the object is invalidated, the item parent is set to $NULL and still cannot be reset.
]]
values {
parent : Efl.Ui.Item;

View File

@ -82,10 +82,10 @@ class @beta Efl.Ui.Popup extends Efl.Ui.Layout_Base implements Efl.Content, Efl.
- the Popup is resized
- the parent window is resized
If @.anchor.get returns NULL, the anchor is the parent window of the Popup.
If @.anchor.get returns $NULL, the anchor is the parent window of the Popup.
If the anchor object is set to $NULL, the Popup will no longer recalculate its alignment or change
its position under any circumstance.
If the Popup is moved by using @Efl.Gfx.Entity.position.set, $anchor is set NULL.
If the Popup is moved by using @Efl.Gfx.Entity.position.set, $anchor is set $NULL.
]]
set {
}

View File

@ -118,7 +118,7 @@ interface @beta Efl.Ui.Position_Manager.Data_Access_V1 {
values {
obj_access : Efl.Ui.Position_Manager.Object_Batch_Callback; [[Function callback for canvas objects, even if
the start_id is valid, the returned objects
may be NULL.]]
may be $NULL.]]
size_access : Efl.Ui.Position_Manager.Size_Batch_Callback; [[Function callback for the size, returned values
are always valid, but might be changed later on.
]]

View File

@ -12,7 +12,7 @@ class @beta Efl.Ui.Scroll.Manager extends Efl.Object implements
This property is protected as it is meant for scrollable object
implementations only, to set and access the internal pan object.
If pan is set to NULL, scrolling does not work.
If pan is set to $NULL, scrolling does not work.
]]
set {
}

View File

@ -91,7 +91,7 @@ class @beta Efl.Ui.Spotlight.Container extends Efl.Ui.Layout_Base implements Efl
]]
params {
deletion_on_transition_end : bool; [[If $true, then the object will be deleted before resolving the future,
and a NULL pointer is the value of the future.
and a $NULL pointer is the value of the future.
$false if no operation should be applied to it.]]
}
return : future<Efl.Gfx.Entity>; [[This Future gets resolved when any transition animation finishes and the

View File

@ -40,7 +40,7 @@ class @beta Efl.Ui.Tags extends Efl.Ui.Layout_Base
get {
}
values {
items: const(array<string>); [[The array of items, or NULL if none.]]
items: const(array<string>); [[The array of items, or $NULL if none.]]
}
}
}

View File

@ -359,7 +359,7 @@ class @beta Efl.Ui.Text extends Efl.Ui.Layout_Base implements Efl.Input.Clickabl
}
events {
changed: void; [[Called when entry changes]]
/* can be NULL, tag nullable once Eolian supports it */
/* can be $NULL, tag nullable once Eolian supports it */
changed,user: Efl.Ui.Text_Change_Info;
[[The text object has changed due to user interaction]]
validate: Elm.Validate_Content; [[Called when validating]]

View File

@ -36,7 +36,7 @@ class @beta Elm.Code_Widget extends Efl.Ui.Layout
@property font {
set {
[[Set the font that this widget uses, the font should be a monospaced scalable font.
Passing NULL will load the default system monospaced font.]]
Passing $NULL will load the default system monospaced font.]]
}
get {
[[Get the font currently in use.

View File

@ -205,7 +205,7 @@ abstract Efl.Object
The object from the provider will then be returned.
The base implementation calls the provider_find function on the object parent,
and returns its result. If no parent is present NULL is returned.
and returns its result. If no parent is present $NULL is returned.
Each implementation has to support this function by overriding
it and returning itself if the interface matches the parameter.
If this is not done the class cannot be found up in the object tree.

View File

@ -14,7 +14,7 @@ class @beta Efl.Canvas.Animation_Rotate extends Efl.Canvas.Animation
from_degree: double; [[Rotation degree when animation starts]]
to_degree: double; [[Rotation degree when animation ends]]
pivot: Efl.Canvas.Object; [[Pivot object for the center point.
If the pivot object is NULL, then the object is rotated on itself.]]
If the pivot object is $NULL, then the object is rotated on itself.]]
cx: double; [[X relative coordinate of the center point.
The left end is 0.0 and the right end is 1.0 (the center is 0.5).]]
cy: double; [[Y relative coordinate of the center point.

View File

@ -15,7 +15,7 @@ class @beta Efl.Canvas.Animation_Scale extends Efl.Canvas.Animation
from_scale_y: double; [[Scale factor along y axis when animation starts]]
to_scale_x: double; [[Scale factor along x axis when animation ends]]
to_scale_y: double; [[Scale factor along y axis when animation ends]]
pivot: Efl.Canvas.Object; [[Pivot object for the center point. If the pivot object is NULL, then the object
pivot: Efl.Canvas.Object; [[Pivot object for the center point. If the pivot object is $NULL, then the object
is scaled on itself.]]
cx: double; [[X relative coordinate of the center point. The left end is 0.0 and the right end is 1.0
(the center is 0.5).]]