Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

docs chanegs

  • Loading branch information...
commit 2a29e9614d10ab061e68fbeb4e6f0f88e5dcb14a 1 parent cdd111d
@blazeeboy authored
View
2  Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NUMBER = 0.1
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = "../vunsy-docs/Doxygen Docs"
+OUTPUT_DIRECTORY = "../vunsy-docs/vunsy API"
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
View
4 system/application/controllers/admin.php
@@ -1,6 +1,6 @@
<?php
-/**
- * admin controller
+/** \addtogroup Controllers
+ * Admin controller
*
* @package Vunsy
* @subpackage Vunsy
View
4 system/application/controllers/page.php
@@ -1,6 +1,6 @@
<?php
-/**
- * page controller that shows current
+/** \addtogroup Controllers
+ * Page controller that shows current
* section from vunsy object
*
* @package Vunsy
View
11 system/application/controllers/remote.php
@@ -1,7 +1,10 @@
<?php
-/**
- * remote access controller
- *
+/** \addtogroup Controllers
+ * Remote access controller
+ *that controller serves the AJAX purpose
+ * , it provide the files , content, directory widgets with
+ * the information needed through AJAX
+ *
* @package Vunsy
* @subpackage Vunsy
* @category controller file
@@ -98,7 +101,7 @@ function ajax($file='')
}*/
- /**
+ /*
* loads returns the content information field
* @param $id: the content id you want to retrieve it's information
* you can use it via AJAX using the URL : site_url('remote/content/20');
View
13 system/application/controllers/users.php
@@ -1,6 +1,11 @@
<?php
-/**
- * user login and out controller
+/** \addtogroup Controllers
+ * Users login and logout controller* users controller perform login and logout action
+ * you can use it like that :
+ * make a form contain inputs ( user, pass ) and
+ * the the action is site_url( 'users/login' ) OR for short site_url('login' )
+ * if you want to logout just direct your user to
+ * site_url( 'users/logout' ) OR for short site_url( 'logout' )
*
* @package Vunsy
* @subpackage Vunsy
@@ -27,8 +32,8 @@ function Users()
* login the user and return to index
* it takes the input from POST
* input needed
- * @param user : for user name
- * @param pass : for the password
+ * -user : for user name
+ * -pass : for the password
* */
function login()
{
View
4 system/application/helpers/page_helper.php
@@ -1,7 +1,7 @@
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
-/*!\file page_helper.php
+/*! \addtogroup Helpers
*
- * page helper functions
+ * page_helper.php functions
* to add javascripts ans css links
* to the page header
*
View
4 system/application/libraries/Gui.php
@@ -1,6 +1,6 @@
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
-/*! \file
- * gui class used to generate multiple HTML text
+/*! \addtogroup Libraries
+ * Gui class: used to generate multiple HTML text
* used with content, applications, it's very useful with
* generating forms, tables, titlepanels, splitters, error messages,
* information messages, colorpickers and a lot more
View
6 system/application/libraries/Twitter.php
@@ -1,7 +1,9 @@
<?php
+/** \addtogroup Libraries
+* Twitter class: A CodeIgniter library to allow use of the Twitter API
+* */
/**
-* A CodeIgniter library to allow use of the Twitter API
*
* Example Usage:
*
@@ -526,4 +528,4 @@ function _build_params($array, $query_string = TRUE){
function get_last_error(){
return $this->last_error;
}
-}
+}
View
4 system/application/libraries/Vunsy.php
@@ -1,6 +1,6 @@
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
-/**
- * Vunsy main Class
+/** \addtogroup Libraries
+ * Vunsy main Class that store user , section, level, and all other main data
*
* @package Vunsy
* @subpackage Vunsy
View
4 system/application/libraries/app.php
@@ -1,6 +1,6 @@
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
-/**
- * application class
+/** \addtogroup Libraries
+ * app class: application class that loads and render application pages
*
* @package Vunsy
* @subpackage Vunsy
View
4 system/application/models/content.php
@@ -1,6 +1,6 @@
<?php
-/**
- * content class
+/** \addtogroup Models
+ * Content class that holds the content data from the database
*
* @package Vunsy
* @subpackage Vunsy
View
4 system/application/models/section.php
@@ -1,6 +1,6 @@
<?php
-/**
- * section class
+/** \addtogroup Models
+ * Section class: a datamapper class that holds page data from the database
*
* @package Vunsy
* @subpackage Vunsy
View
4 system/application/models/user.php
@@ -1,6 +1,6 @@
<?php
-/**
- * user class
+/** \addtogroup Models
+ * User class instance of datamapper that holds user data
*
* @package Vunsy
* @subpackage Vunsy
View
4 system/application/models/userlevel.php
@@ -1,6 +1,6 @@
<?php
-/**
- * user level class
+/** \addtogroup Models
+ * Userlevel class: datamapper class that holds userlevel data from the database
*
* @package Vunsy
* @subpackage Vunsy
Please sign in to comment.
Something went wrong with that request. Please try again.