Adiciona documentação para os arquivos menores

delibera-edit-form-comment.php

@@ -1,14 +1,14 @@
 <?php
 /**
  * Utilização do arquivo diretamente no tema.
+ * @namespace Comentarios
  */
 
 /**
  * Template utilizado ao tentar editar um comentário na pauta
  *
  * É adicionado formulário e botões para editar ou remover comentários
  *
- * @package Template
  */
 function delibera_template_edit_comment() {}
 ?>

delibera.php

@@ -19,6 +19,10 @@
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
+/**
+ * Reponsável por importar todos os arquivos utilizados pelo plugin
+ * @package Global
+ */
 
 if(!defined('__DIR__')) {
     $iPos = strrpos(__FILE__, DIRECTORY_SEPARATOR);
@@ -104,4 +108,4 @@
         return $redirect_to;
     }
 }, 10, 3);
-TODO mundo redirecionado para a lista de pauta, talvez uma nova opções */
+TODO mundo redirecionado para a lista de pauta, talvez uma nova opções */

delibera_admin_functions.php

@@ -1,15 +1,14 @@
 <?php
 /**
  * Realiza modificações no painel administrativo do wordpress
+ * @package Pauta\Admin
  */
 
 /**
  * Função para incluir a ação de edição em massa para prazo de discussão
  *
  * @property admin_footer
  * @return null
- * @package Action
- * @subpackage Admin
  */
 function delibera_custom_bulk_admin_footer() {
 
@@ -42,8 +41,6 @@ function delibera_custom_bulk_admin_footer() {
 /**
  * Função que trata a ação de edição em massa do prazo de discussão
  *
- * @package Action
- * @subpackage Admin
  */
 function delibera_custom_bulk_action() {
 
@@ -81,8 +78,6 @@ function delibera_custom_bulk_action() {
 /**
  * Função que exibe a mensagem de confirmação da alteração em massa
  *
- * @package Action
- * @subpackage Admin
  */
 function delibera_custom_bulk_admin_notices() {
 
@@ -103,8 +98,6 @@ function delibera_custom_bulk_admin_notices() {
  * @param WP_comment $comment
  *
  * @property add_meta_boxes_comment
- * @package Action
- * @subpackage Admin
  */
 function delibera_edit_comment($comment)
 {
@@ -162,8 +155,7 @@ function delibera_edit_comment($comment)
 /**
  * Internacionaliza label das propriedades
  *
- * @package Action
- * @subpackage Admin
+ * @param $columns
  *
  */
  function delibera_edit_columns($columns)
@@ -177,10 +169,9 @@ function delibera_edit_columns($columns)
 add_filter('manage_edit-pauta_columns', 'delibera_edit_columns');
 
 /**
+ * Retorna valor de determinada coluna da pauta
  *
- *
- * @package Action
- * @subpackage Admin
+ * @param $columns
  *
  */
 function delibera_post_custom_column($column)
@@ -214,10 +205,9 @@ function delibera_post_custom_column($column)
 add_action('manage_posts_custom_column',  'delibera_post_custom_column');
 
 /**
- *
- *
- * @package Action
- * @subpackage Admin
+ * Inclui novas ações na lista do wp admin
+ * @param $columns
+ * @param $post
  *
  */
 function delibera_admin_list_options($actions, $post)
@@ -251,10 +241,7 @@ function delibera_admin_list_options($actions, $post)
 add_filter('post_row_actions','delibera_admin_list_options', 10, 2);
 
 /**
- *
- *
- * @package Action
- * @subpackage Admin
+ * Preenche lista de valores disponíveis para filtro da listagem do WP admin
  *
  */
 function delibera_restrict_listings()

delibera_comments_query.php

@@ -1,4 +1,13 @@
 <?php
+/**
+ * Customização da busca por comentários
+ * @package Comentarios
+ */
+
+/**
+ * Implementação básica de modificação na busca por comentários nos posts do tipo 'pauta'
+ *
+ */
 class delibera_WP_Comment_Query extends WP_Comment_Query
 {
 /**

delibera_comments_template.php

@@ -1,16 +1,28 @@
 <?php
+/**
+ * Implementa classe utilizada para buscar comentários ao utilizar `wp_get_list_comments`
+ * @package Comentarios\Template
+ */
 
+/**
+ * Classe utilizada para hackear a forma de buscar os comentários
+ * 
+ * @see http://shinraholdings.com/621/custom-walker-to-extend-the-walker_comment-class/
+ */
 class Delibera_Walker_Comment_padrao extends Walker_Comment
 {
 
     /**
+     * Altera resultado da função `wp_get_list_comments` ao ser utilizado como walker
+     * 
      * @see Walker::start_el()
      * @since 2.7.0
      *
      * @param string $output Passed by reference. Used to append additional content.
      * @param object $comment Comment data object.
      * @param int $depth Depth of comment in reference to parents.
      * @param array $args
+     * @param int @current_object_id
      */
     function start_el(&$output, $comment, $depth = 0, $args = array(), $current_object_id = 0) {
         $depth++;

delibera_conf.php

@@ -1,13 +1,17 @@
 <?php
-require_once('delibera_conf_themes.php');
-require_once('delibera_conf_roles.php');
+/**
+ * Página de configuração do plugin.
+ * @package Configuracoes
+ */
+
 
 /**
  * Retorna todas as configurações do delibera
  * salvas no banco. Quando não houver um valor
  * salvo no banco para determinada opções retorna o
  * valor padrão.
  *
+ * @package Configuracoes\Template
  * @return array
  */
 function delibera_get_config() {
@@ -31,6 +35,17 @@ function delibera_get_config() {
     return $opt;
 }
 
+require_once('delibera_conf_themes.php');
+require_once('delibera_conf_roles.php');
+
+/**
+ * Retorna do banco de dados configuração principal
+ *
+ * @param array $config -
+ * @return array
+ * @package Configuracoes\Template
+ *
+ */
 function delibera_get_main_config($config = array()) {
     global $deliberaThemes;
 
@@ -67,6 +82,7 @@ function delibera_get_main_config($config = array()) {
  * do Delibera
  *
  * @return null
+ * @package Configuracoes\Admin
  */
 function delibera_conf_page()
 {

delibera_conf_roles.php

@@ -1,6 +1,8 @@
 <?php
+/**
+ * Configuração de permissões.
+ */
 
-// Configuração de permissões
 $delibera_permissoes = array(
 	'administrator' => array('Novo' => false, 'Caps' => array
 	(
@@ -86,7 +88,9 @@
  * Quando estiver na single da pauta, retorna false sempre que ela
  * estiver com o prazo encerrado.
  *
+ * @param string $permissao
  * @return bool
+ * @package Pauta
  */
 function delibera_current_user_can_participate($permissao = 'votar') {
     global $post;
@@ -102,6 +106,13 @@ function delibera_current_user_can_participate($permissao = 'votar') {
     }
 }
 
+/**
+ * Verifica se pauta está aberta para comentários
+ *
+ * @param string $postID
+ *
+ * @package Pauta
+ */
 function delibera_can_comment($postID = '')
 {
 	if(is_null($postID))