Merge pull request #54 from Yoast/JRF/Docs/various-tweaks

Docs: various minor tweaks

Author: jrfnl

src/i18n-v3.php

@@ -49,23 +49,20 @@ class Yoast_I18n_v3 {
 	/**
 	 * Will contain the site's locale.
 	 *
-	 * @access private
 	 * @var string
 	 */
 	private $locale;
 
 	/**
 	 * Will contain the locale's name, obtained from your translation site.
 	 *
-	 * @access private
 	 * @var string
 	 */
 	private $locale_name;
 
 	/**
 	 * Will contain the percentage translated for the plugin translation project in the locale.
 	 *
-	 * @access private
 	 * @var int
 	 */
 	private $percent_translated;
@@ -101,15 +98,13 @@ class Yoast_I18n_v3 {
 	/**
 	 * Indicates whether there's a translation available at all.
 	 *
-	 * @access private
 	 * @var bool
 	 */
 	private $translation_exists;
 
 	/**
 	 * Indicates whether the translation's loaded.
 	 *
-	 * @access private
 	 * @var bool
 	 */
 	private $translation_loaded;
@@ -171,8 +166,6 @@ private function get_admin_locale() {
 	/**
 	 * This is where you decide where to display the messages and where you set the plugin specific variables.
 	 *
-	 * @access private
-	 *
 	 * @param array $args Contains the settings for the class.
 	 */
 	private function init( $args ) {
@@ -184,8 +177,6 @@ private function init( $args ) {
 	/**
 	 * Check whether the promo should be hidden or not.
 	 *
-	 * @access private
-	 *
 	 * @return bool
 	 */
 	private function hide_promo() {
@@ -203,8 +194,6 @@ private function hide_promo() {
 	/**
 	 * Returns the i18n_promo message from the i18n_module. Returns en empty string if the promo shouldn't be shown.
 	 *
-	 * @access public
-	 *
 	 * @return string The i18n promo message.
 	 */
 	public function get_promo_message() {
@@ -218,9 +207,7 @@ public function get_promo_message() {
 	/**
 	 * Generates a promo message.
 	 *
-	 * @access private
-	 *
-	 * @return bool|string $message
+	 * @return bool|string
 	 */
 	private function promo_message() {
 
@@ -280,8 +267,6 @@ public function get_dismiss_i18n_message_button() {
 
 	/**
 	 * Outputs a promo box.
-	 *
-	 * @access public
 	 */
 	public function promo() {
 		$message = $this->get_promo_message();
@@ -306,8 +291,6 @@ public function promo() {
 	/**
 	 * Try to find the transient for the translation set or retrieve them.
 	 *
-	 * @access private
-	 *
 	 * @return object|null
 	 */
 	private function find_or_initialize_translation_details() {
@@ -323,8 +306,6 @@ private function find_or_initialize_translation_details() {
 
 	/**
 	 * Try to get translation details from cache, otherwise retrieve them, then parse them.
-	 *
-	 * @access private
 	 */
 	private function translation_details() {
 		$set = $this->find_or_initialize_translation_details();
@@ -360,8 +341,6 @@ private function get_api_url() {
 	/**
 	 * Retrieve the translation details from Yoast Translate.
 	 *
-	 * @access private
-	 *
 	 * @return object|null
 	 */
 	private function retrieve_translation_details() {
@@ -402,8 +381,6 @@ private function retrieve_translation_details() {
 	 * Set the needed private variables based on the results from Yoast Translate.
 	 *
 	 * @param object $set The translation set.
-	 *
-	 * @access private
 	 */
 	private function parse_translation_set( $set ) {
 		if ( $this->translation_exists && is_object( $set ) ) {

src/i18n-wordpressorg-v3.php

@@ -35,8 +35,6 @@ public function __construct( $args, $show_translation_box = true ) {
 	/**
 	 * Returns the i18n_promo message from the i18n_module.
 	 *
-	 * @access public
-	 *
 	 * @return string The i18n promo message or an empty string if the promo shouldn't be shown.
 	 */
 	public function get_promo_message() {