- * @deprecated api notice
- * @param array entities
- * @return array of deprecated api entities
+ * Get list of deprecated entities.
+ *
+ * This is called by the api wrapper when returning the result of api.Entity.get.
+ *
+ * @param array $entities
+ *
+ * @return array
+ * Array of deprecated api entities