Mark Tox_Options struct as deprecated.

We will remove it in v0.1.
TokTok · Nov 20, 2016 · e78bd7f · e78bd7f
1 parent 3bc5ad1
commit e78bd7f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/toxcore/tox.api.h b/toxcore/tox.api.h
@@ -433,9 +433,10 @@ static class options {
    * in future versions of the API, code that allocates it itself will become
    * incompatible.
    *
-   * The memory layout of this struct (size, alignment, and field order) is not
-   * part of the ABI. To remain compatible, prefer to use $new to allocate the
-   * object and accessor functions to set the members.
+   * @deprecated The memory layout of this struct (size, alignment, and field
+   * order) is not part of the ABI. To remain compatible, prefer to use $new to
+   * allocate the object and accessor functions to set the members. The struct
+   * will become opaque (i.e. the definition will become private) in v0.1.0.
    */
   struct this [get, set] {
     /**

diff --git a/toxcore/tox.h b/toxcore/tox.h
@@ -482,9 +482,10 @@ typedef void tox_log_cb(Tox *tox, TOX_LOG_LEVEL level, const char *file, uint32_
  * in future versions of the API, code that allocates it itself will become
  * incompatible.
  *
- * The memory layout of this struct (size, alignment, and field order) is not
- * part of the ABI. To remain compatible, prefer to use tox_options_new to allocate the
- * object and accessor functions to set the members.
+ * @deprecated The memory layout of this struct (size, alignment, and field
+ * order) is not part of the ABI. To remain compatible, prefer to use tox_options_new to
+ * allocate the object and accessor functions to set the members. The struct
+ * will become opaque (i.e. the definition will become private) in v0.1.0.
  */
 struct Tox_Options {
 
@@ -2913,3 +2914,4 @@ uint16_t tox_self_get_tcp_port(const Tox *tox, TOX_ERR_GET_PORT *error);
 #endif
 
 #endif
+