Genetic: cleaned up doc

tripal_genetic/api/tripal_genetic.api.inc

@@ -1,5 +1,5 @@
 <?php
 /**
  * @file
- * @todo Add file header description
+ * API for managing genetic data
  */

tripal_genetic/includes/tripal_genetic.admin.inc

@@ -1,5 +1,14 @@
 <?php
+/**
+ * @file
+ * Provides administration of chado genetic data
+ */
 
+/**
+ * Administration launchpad
+ *
+ * @ingroup tripal_genetic
+ */
 function tripal_genetic_admin_genetics_listing() {
   $output = '';
 

tripal_genetic/includes/tripal_genetic.schema.inc

@@ -1,4 +1,9 @@
 <?php
+/**
+ * @file
+ * Add to the tripal schema definitions
+ */
+
 /**
  * Implements hook_chado_schema_v1_11_table()
  * Purpose: To add descriptions and foreign keys to default table description

tripal_genetic/tripal_genetic.install

@@ -1,7 +1,14 @@
 <?php
+/**
+ * @file
+ * Installation of the tripal genetic module
+ */
 
 /**
+ * Implements hook_disable().
  * Disable default views when module is disabled
+ *
+ * @ingroup tripal_genetic
  */
 function tripal_genetic_disable() {
 

tripal_genetic/tripal_genetic.module

@@ -1,4 +1,8 @@
 <?php
+/**
+ * @file
+ * Basic functionality for the genetic
+ */
 
 /**
  * @defgroup tripal_genetic Genetic Module
@@ -8,10 +12,12 @@
  * @}
  */
 
-require('api/tripal_genetic.api.inc');
-require('theme/tripal_genetic.theme.inc');
-require('includes/tripal_genetic.schema.inc');
-require('includes/tripal_genetic.admin.inc');
+require 'api/tripal_genetic.api.inc';
+
+require 'theme/tripal_genetic.theme.inc';
+
+require 'includes/tripal_genetic.schema.inc';
+require 'includes/tripal_genetic.admin.inc';
 
 /**
  * Implements hook_permission().
@@ -29,7 +35,10 @@ function tripal_genetic_permission() {
     ),
   );
 }
+
 /**
+ *  Implements hook_menu().
+ *
  *  Menu items are automatically added for the new node types created
  *  by this module to the 'Create Content' Navigation menu item.  This function
  *  adds more menu items needed for this module.
@@ -69,8 +78,9 @@ function tripal_genetic_menu() {
 }
 
 /**
- * Implements hook_views_api()
- * Purpose: Essentially this hook tells drupal that there is views support for
+ * Implements hook_views_api().
+ *
+ * Essentially this hook tells drupal that there is views support for
  *  for this module which then includes tripal_genetic.views.inc where all the
  *  views integration code is
  *
@@ -111,7 +121,7 @@ function tripal_genetic_theme($existing, $type, $theme, $path) {
 }
 
 /**
- * Implements hook_nodeapi().
+ * Implements hook_node_view(). Acts on all content types
  *
  * @ingroup tripal_genetic
  */

tripal_genetic/tripal_genetic.views_default.inc

@@ -1,7 +1,13 @@
 <?php
+/**
+ * @file
+ * Describe default genetic views
+ */
 
 /**
  * Implements hook_views_default_views().
+ *
+ * @ingroup tripal_genetic
  */
 function tripal_genetic_views_default_views() {
   $views = array();
@@ -12,6 +18,11 @@ function tripal_genetic_views_default_views() {
   return $views;
 }
 
+/**
+ * Describes the default administration genetic view
+ *
+ * @ingroup tripal_genetic
+ */
 function tripal_genetic_defaultviews_admin_genotypes() {
 
   $view = new view();
@@ -123,4 +134,4 @@ function tripal_genetic_defaultviews_admin_genotypes() {
   $handler->display->display_options['tab_options']['weight'] = '0';
 
   return $view;
-}
+}