AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

Various documentation suggests across a few domains.

Browse Source 
| domain | current | suggestion |
|--------|---------|------------|
| [GtkSeparator](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtkseparator.c#L39)    | "`![An example GtkSeparator](separators.png)`" | "`![An example GtkSeparator](separator.png)`" [1] |
| [GtkTextBuffer](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextbuffer.c#L4885)  | "if there is an redoable action" | "if there is a redoable action" |
| [GtkTextBuffer/get_enable_undo](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextbuffer.c#L5005) | (Renders `No description available.`) | "Returns: %TRUE if undoing and redoing changes to the buffer is allowed." [3] |
| [GtkTextBuffer/get_max_undo_levels](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextbuffer.c#L5102) | (Renders `No description available.`)| "Returns: The max number of undo levels allowed (0 indicates unlimited)." |
| [GtkTextBuffer](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextbuffer.c#L3874) | "with gtk_text_buffer_add_selection_clipboard()." | "with [method@Gtk.TextBuffer.add_selection_clipboard]" |
| [GtkTextBuffer](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextbuffer.c#L3494) | "it will automatically toggled" | "it will automatically toggle" |

* [1] See : [separator.png](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/docs/reference/gtk/images/separator.png), [gtk4.toml.in](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/docs/reference/gtk/gtk4.toml.in#L218), [visual_index.md](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/docs/reference/gtk/visual_index.md?plain=1#L16)
* [2] Taken from `enable-undo` [property description](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextbuffer.c#L516)

* [GtkTextMark/gtk_text_mark_set_visible](https://docs.gtk.org/gtk4/method.TextMark.set_visible.html) is defined in [GtkTextMark's header](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextmark.h#L93), but implemented in [GtkTextBTree](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/gtk/gtktextbtree.c#L3036).
  * Other than being kind of confusing, this causes `gtk_text_mark_set_visible()`'s doc to not render where it expects it to.
This commit is contained in:
Cam Cook 2023-01-02 13:47:55 -05:00
parent f6bd63c9ad
commit 9396ccf9ff
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gtk/gtkseparator.c
View File

@ -36,7 +36,7 @@
*
* `GtkSeparator` is a horizontal or vertical separator widget.
*
* ![An example GtkSeparator](separators.png)
* ![An example GtkSeparator](separator.png)
*
* A `GtkSeparator` can be used to group the widgets within a window.
* It displays a line with a shadow to make it appear sunken into the

10
gtk/gtktextbuffer.c
View File

@ -3491,7 +3491,7 @@ gtk_text_buffer_get_modified (GtkTextBuffer *buffer)
* Whenever the buffer is saved to disk, call
* `gtk_text_buffer_set_modified (@buffer, FALSE)`.
* When the buffer is modified, it will automatically
* toggled on the modified bit again. When the modified
* toggle on the modified bit again. When the modified
* bit flips, the buffer emits the
* [signal@Gtk.TextBuffer::modified-changed] signal.
*/
@ -3871,7 +3871,7 @@ gtk_text_buffer_add_selection_clipboard (GtkTextBuffer *buffer,
* [method@Gtk.TextBuffer.add_selection_clipboard]
*
* Removes a `GdkClipboard` added with
* gtk_text_buffer_add_selection_clipboard().
* [method@Gtk.TextBuffer.add_selection_clipboard]
*/
void
gtk_text_buffer_remove_selection_clipboard (GtkTextBuffer *buffer,
@ -4882,7 +4882,7 @@ gtk_text_buffer_get_can_undo (GtkTextBuffer *buffer)
*
* Gets whether there is a redoable action in the history.
*
* Returns: %TRUE if there is an redoable action
* Returns: %TRUE if there is a redoable action
*/
gboolean
gtk_text_buffer_get_can_redo (GtkTextBuffer *buffer)
@ -5003,6 +5003,8 @@ gtk_text_buffer_redo (GtkTextBuffer *buffer)
* See [method@Gtk.TextBuffer.begin_irreversible_action] and
* [method@Gtk.TextBuffer.end_irreversible_action] to create
* changes to the buffer that cannot be undone.
*
* Returns: %TRUE if undoing and redoing changes to the buffer is allowed.
*/
gboolean
gtk_text_buffer_get_enable_undo (GtkTextBuffer *buffer)
@ -5100,6 +5102,8 @@ gtk_text_buffer_end_irreversible_action (GtkTextBuffer *buffer)
* If 0, unlimited undo actions may be performed. Note that this may
* have a memory usage impact as it requires storing an additional
* copy of the inserted or removed text within the text buffer.
*
* Returns: The max number of undo levels allowed (0 indicates unlimited).
*/
guint
gtk_text_buffer_get_max_undo_levels (GtkTextBuffer *buffer)