docs: update generated docs for new changes in EO files
This commit is contained in:
parent
98a34acef0
commit
ffc698af44
|
@ -73,6 +73,7 @@ digraph hierarchy {
|
|||
| [[:docs:efl:auto:class:efl:io:buffered_stream:property:max_queue_size_output|max_queue_size_output]] //(get, set)// | %%Limit how big the output queue can grow, in bytes.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:property:pending_read|pending_read]] //(get)// | %%How many bytes are pending (available) for read%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:property:pending_write|pending_write]] //(get)// | %%How many bytes are pending write to %%[[:docs:efl:auto:class:efl:io:buffered_stream:property:inner_io|Efl.Io.Buffered_Stream.inner_io]]%%%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:property:progress|progress]] //(get)// | %%How many bytes were written and read.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:property:read_chunk_size|read_chunk_size]] //(get, set)// | %%Read chunk size property, in bytes.%% |
|
||||
|
||||
===== Events =====
|
||||
|
@ -81,6 +82,7 @@ digraph hierarchy {
|
|||
| [[:docs:efl:auto:class:efl:io:buffered_stream:event:error|error]] | %%An error happened and the I/O stopped%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:event:finished|finished]] | %%Both read and write are finished.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:event:line|line]] | %%If %%[[:docs:efl:auto:class:efl:io:buffered_stream:property:line_delimiter|Efl.Io.Buffered_Stream.line_delimiter]]%% is set, will be emitted with current line. The memory is only valid during event callback dispatched and should not be modified. Note that the line slice may not be inside %%[[:docs:efl:auto:class:efl:io:buffered_stream:method:slice_get|Efl.Io.Buffered_Stream.slice_get]]%%, don't assume that!%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:event:progress|progress]] | %%Property %%[[:docs:efl:auto:class:efl:io:buffered_stream:property:progress|Efl.Io.Buffered_Stream.progress]]%% changed%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:event:read_finished|read,finished]] | %%Same as %%[[:docs:efl:auto:interface:efl:io:reader|Efl.Io.Reader]]%% "eos", for consistency.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:event:slice_changed|slice,changed]] | %%The read-slice returned by %%[[:docs:efl:auto:class:efl:io:buffered_stream:method:slice_get|Efl.Io.Buffered_Stream.slice_get]]%% may have changed.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:buffered_stream:event:write_finished|write,finished]] | %%%%[[:docs:efl:auto:class:efl:io:buffered_stream:method:eos_mark|Efl.Io.Buffered_Stream.eos_mark]]%% was called and all available data was sent to destination%% |
|
||||
|
|
|
@ -0,0 +1,20 @@
|
|||
<title>Efl.Io.Buffered_Stream: progress</title>
|
||||
===== Signature =====
|
||||
|
||||
<code>
|
||||
progress;
|
||||
</code>
|
||||
|
||||
===== C signature =====
|
||||
|
||||
<code c>
|
||||
void EFL_IO_BUFFERED_STREAM_EVENT_PROGRESS;
|
||||
</code>
|
||||
|
||||
===== Description =====
|
||||
|
||||
%%Property %%[[:docs:efl:auto:class:efl:io:buffered_stream:property:progress|Efl.Io.Buffered_Stream.progress]]%% changed%%
|
||||
|
||||
//Since 1.19//
|
||||
{{page>:docs:efl:user:class:efl:io:buffered_stream:event:progress:description&nodate&nolink&nouser}}
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
<title>Efl.Io.Buffered_Stream.progress</title>
|
||||
===== Signature =====
|
||||
|
||||
<code>
|
||||
@property Efl.Io.Buffered_Stream.progress {
|
||||
get {
|
||||
values {
|
||||
read_bytes: size;
|
||||
written_bytes: size;
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
|
||||
===== C signature =====
|
||||
|
||||
<code c>
|
||||
void efl_io_buffered_stream_progress_get(const Eo *obj, size_t *read_bytes, size_t *written_bytes);
|
||||
</code>
|
||||
|
||||
===== Values =====
|
||||
|
||||
* **read_bytes** - %%Bytes that were read until now%%
|
||||
* **written_bytes** - %%Bytes that were written until now%%
|
||||
|
||||
{{page>:docs:efl:user:class:efl:io:buffered_stream:property:progress:description&nodate&nolink&nouser}}
|
||||
|
|
@ -80,6 +80,7 @@ digraph hierarchy {
|
|||
| [[:docs:efl:auto:class:efl:io:copier:property:done|done]] //(get, set)// | %%Reports if copier is done.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:copier:property:inactivity_timeout|inactivity_timeout]] //(get, set)// | %%Terminate the copier with ETIMEDOUT if it becomes inactive for some time.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:copier:property:line_delimiter|line_delimiter]] //(get, set)// | %%If there is a line delimiter, the reads will buffer/queue up to the line delimiter before calling %%[[:docs:efl:auto:interface:efl:io:writer:method:write|Efl.Io.Writer.write]]%% on the %%[[:docs:efl:auto:class:efl:io:copier:property:destination|Efl.Io.Copier.destination]]%% and the event line is emitted with current line. The line may include the delimiter, unless it's end-of-stream on %%[[:docs:efl:auto:class:efl:io:copier:property:source|Efl.Io.Copier.source]]%% or %%[[:docs:efl:auto:class:efl:io:copier:property:buffer_limit|Efl.Io.Copier.buffer_limit]]%% was reached.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:copier:property:pending_size|pending_size]] //(get)// | %%Returns the size of the pending buffer.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:copier:property:progress|progress]] //(get)// | %%Progress for read and write.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:copier:property:read_chunk_size|read_chunk_size]] //(get, set)// | %%Copier read chunk size property, in bytes.%% |
|
||||
| [[:docs:efl:auto:class:efl:io:copier:property:source|source]] //(get, set)// | %%Copier source object.%% |
|
||||
|
|
|
@ -0,0 +1,25 @@
|
|||
<title>Efl.Io.Copier.pending_size</title>
|
||||
===== Signature =====
|
||||
|
||||
<code>
|
||||
@property Efl.Io.Copier.pending_size {
|
||||
get {
|
||||
values {
|
||||
size: size;
|
||||
}
|
||||
}
|
||||
}
|
||||
</code>
|
||||
|
||||
===== C signature =====
|
||||
|
||||
<code c>
|
||||
size_t efl_io_copier_pending_size_get(const Eo *obj);
|
||||
</code>
|
||||
|
||||
===== Values =====
|
||||
|
||||
* **size** - %%The pending buffer size, in bytes.%%
|
||||
|
||||
{{page>:docs:efl:user:class:efl:io:copier:property:pending_size:description&nodate&nolink&nouser}}
|
||||
|
|
@ -30,6 +30,8 @@ void efl_net_ssl_context_certificate_authorities_set(Eo *obj, Eina_Iterator *pat
|
|||
|
||||
%%The list of paths to CA (certificate authoritie) to use.%%
|
||||
|
||||
%%Can only be set during object construction!%%
|
||||
|
||||
//Since 1.19//{{page>:docs:efl:user:class:efl:net:ssl:context:property:certificate_authorities:description&nodate&nolink&nouser}}
|
||||
|
||||
|
||||
|
|
|
@ -30,6 +30,8 @@ void efl_net_ssl_context_certificate_revogation_lists_set(Eo *obj, Eina_Iterator
|
|||
|
||||
%%The list of paths to CRL (certificate revogation list) to use.%%
|
||||
|
||||
%%Can only be set during object construction!%%
|
||||
|
||||
//Since 1.19//{{page>:docs:efl:user:class:efl:net:ssl:context:property:certificate_revogation_lists:description&nodate&nolink&nouser}}
|
||||
|
||||
|
||||
|
|
|
@ -30,6 +30,8 @@ void efl_net_ssl_context_certificates_set(Eo *obj, Eina_Iterator *paths);
|
|||
|
||||
%%The list of paths to certificates to use.%%
|
||||
|
||||
%%Can only be set during object construction!%%
|
||||
|
||||
//Since 1.19//{{page>:docs:efl:user:class:efl:net:ssl:context:property:certificates:description&nodate&nolink&nouser}}
|
||||
|
||||
|
||||
|
|
|
@ -30,6 +30,8 @@ void efl_net_ssl_context_default_paths_load_set(Eo *obj, Eina_Bool default_paths
|
|||
|
||||
%%If %%''true''%%, will use system's default certificate storage%%
|
||||
|
||||
%%Can only be set during object construction!%%
|
||||
|
||||
//Since 1.19//{{page>:docs:efl:user:class:efl:net:ssl:context:property:default_paths_load:description&nodate&nolink&nouser}}
|
||||
|
||||
|
||||
|
|
|
@ -30,6 +30,8 @@ void efl_net_ssl_context_private_keys_set(Eo *obj, Eina_Iterator *paths);
|
|||
|
||||
%%The list of paths to private keys to use.%%
|
||||
|
||||
%%Can only be set during object construction!%%
|
||||
|
||||
//Since 1.19//{{page>:docs:efl:user:class:efl:net:ssl:context:property:private_keys:description&nodate&nolink&nouser}}
|
||||
|
||||
|
||||
|
|
|
@ -9,7 +9,8 @@ enum Efl.Image.Load.Error {
|
|||
permission_denied: 3,
|
||||
resource_allocation_failed: 4,
|
||||
corrupt_file: 5,
|
||||
unknown_format: 6
|
||||
unknown_format: 6,
|
||||
cancelled: 7
|
||||
}
|
||||
</code>
|
||||
|
||||
|
@ -23,7 +24,8 @@ typedef enum {
|
|||
EFL_IMAGE_LOAD_ERROR_PERMISSION_DENIED = 3,
|
||||
EFL_IMAGE_LOAD_ERROR_RESOURCE_ALLOCATION_FAILED = 4,
|
||||
EFL_IMAGE_LOAD_ERROR_CORRUPT_FILE = 5,
|
||||
EFL_IMAGE_LOAD_ERROR_UNKNOWN_FORMAT = 6
|
||||
EFL_IMAGE_LOAD_ERROR_UNKNOWN_FORMAT = 6,
|
||||
EFL_IMAGE_LOAD_ERROR_CANCELLED = 7
|
||||
} Efl_Image_Load_Error;
|
||||
</code>
|
||||
|
||||
|
@ -44,4 +46,5 @@ typedef enum {
|
|||
* **resource_allocation_failed** - %%Allocation of resources failure prevented load%%
|
||||
* **corrupt_file** - %%File corrupt (but was detected as a known format)%%
|
||||
* **unknown_format** - %%File is not a known format%%
|
||||
* **cancelled** - %%Reading operation has been cancelled during decoding%%
|
||||
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
{{page>:docs:efl:auto:enum:efl:image:load:error}}
|
|
@ -0,0 +1 @@
|
|||
{{page>:docs:efl:auto:class:efl:io:buffered_stream:event:progress}}
|
|
@ -0,0 +1 @@
|
|||
{{page>:docs:efl:auto:class:efl:io:buffered_stream:property:progress}}
|
|
@ -0,0 +1 @@
|
|||
{{page>:docs:efl:auto:class:efl:io:copier:property:pending_size}}
|
|
@ -282,6 +282,7 @@ EFL_IMAGE_CONTENT_HINT_STATIC
|
|||
EFL_IMAGE_EVENT_PRELOAD
|
||||
EFL_IMAGE_EVENT_RESIZE
|
||||
EFL_IMAGE_EVENT_UNLOAD
|
||||
EFL_IMAGE_LOAD_ERROR_CANCELLED
|
||||
EFL_IMAGE_LOAD_ERROR_CORRUPT_FILE
|
||||
EFL_IMAGE_LOAD_ERROR_DOES_NOT_EXIST
|
||||
EFL_IMAGE_LOAD_ERROR_GENERIC
|
||||
|
@ -350,6 +351,7 @@ EFL_INPUT_VALUE_Y
|
|||
EFL_IO_BUFFERED_STREAM_EVENT_ERROR
|
||||
EFL_IO_BUFFERED_STREAM_EVENT_FINISHED
|
||||
EFL_IO_BUFFERED_STREAM_EVENT_LINE
|
||||
EFL_IO_BUFFERED_STREAM_EVENT_PROGRESS
|
||||
EFL_IO_BUFFERED_STREAM_EVENT_READ_FINISHED
|
||||
EFL_IO_BUFFERED_STREAM_EVENT_SLICE_CHANGED
|
||||
EFL_IO_BUFFERED_STREAM_EVENT_WRITE_FINISHED
|
||||
|
@ -3357,6 +3359,7 @@ efl_io_buffered_stream_max_queue_size_output_get
|
|||
efl_io_buffered_stream_max_queue_size_output_set
|
||||
efl_io_buffered_stream_pending_read_get
|
||||
efl_io_buffered_stream_pending_write_get
|
||||
efl_io_buffered_stream_progress_get
|
||||
efl_io_buffered_stream_read_chunk_size_get
|
||||
efl_io_buffered_stream_read_chunk_size_set
|
||||
efl_io_buffered_stream_slice_get
|
||||
|
@ -3381,6 +3384,7 @@ efl_io_copier_inactivity_timeout_get
|
|||
efl_io_copier_inactivity_timeout_set
|
||||
efl_io_copier_line_delimiter_get
|
||||
efl_io_copier_line_delimiter_set
|
||||
efl_io_copier_pending_size_get
|
||||
efl_io_copier_progress_get
|
||||
efl_io_copier_read_chunk_size_get
|
||||
efl_io_copier_read_chunk_size_set
|
||||
|
|
Loading…
Reference in New Issue