Changeset 3605Tweet

Timestamp:

Aug 2, 2009, 1:09:29 PM (10 years ago)

Author:

Sam Hocevar

Message:

Add a note about autoreleased canvases in the documentation.

File:

• libcaca/trunk/doc/migrating.dox (modified) (2 diffs)

libcaca/trunk/doc/migrating.dox

@@ -113 +113 @@
  - \b caca_init(): use caca_create_canvas() to create a \e libcaca canvas,
    followed by caca_create_display() to attach a \e libcaca display to it.
+   Alternatively, caca_create_display() with a NULL argument will create a
+   canvas automatically.
  - \b caca_set_delay(): use caca_set_display_time().
  - \b caca_get_feature(): deprecated.
@@ -129 +131 @@
  - \b caca_end(): use caca_free_display() to detach the \e libcaca display,
    followed by caca_free_canvas() to free the underlying \e libcaca canvas.
+   Alternatively, if the canvas was created by caca_create_display(), it
+   will be automatically destroyed by caca_free_display().
 
  \subsection bar2 Event handling