Changeset 39023

Timestamp:

10/30/2016 04:35:30 PM (10 years ago)

Author:

DrewAPicture

Message:

Docs: Add much more complete and syntactically correct documentation throughout the WP_REST_Post_Meta_Fields class.

Props Soean, mrahmadawais, flixos90.
See #38398.

File:

• trunk/src/wp-includes/rest-api/fields/class-wp-rest-post-meta-fields.php (modified) (4 diffs)

trunk/src/wp-includes/rest-api/fields/class-wp-rest-post-meta-fields.php

@@ -1 +1 @@
 <?php
+/**
+ * REST API: WP_REST_Post_Meta_Fields class
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 4.7.0
+ */
 
+/**
+ * Core class used to manage meta values for posts via the REST API.
+ *
+ * @since 4.7.0
+ *
+ * @see WP_REST_Meta_Fields
+ */
 class WP_REST_Post_Meta_Fields extends WP_REST_Meta_Fields {
+
         /**
          * Post type to register fields for.
          *
+         * @since 4.7.0
+         * @access protected
          * @var string
          */
@@ -11 +28 @@
         /**
          * Constructor.
+         *
+         * @since 4.7.0
+         * @access public
          *
          * @param string $post_type Post type to register fields for.
@@ -19 +39 @@
 
         /**
-         * Get the object type for meta.
+         * Retrieves the object meta type.
          *
-         * @return string
+         * @since 4.7.0
+         * @access protected
+         *
+         * @return string The meta type.
          */
         protected function get_meta_type() {
@@ -28 +51 @@
 
         /**
-         * Get the type for `register_rest_field`.
+         * Retrieves the type for register_rest_field().
          *
-         * @return string Custom post type slug.
+         * @since 4.7.0
+         * @access public
+         *
+         * @see register_rest_field()
+         *
+         * @return string The REST field type.
          */
         public function get_rest_field_type() {