admin/opensimWebAssets
1
0
Fork 0
mirror of https://github.com/TechplexEngineer/opensimWebAssets.git synced 2026-08-14 09:12:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc : a few more doxygen tags

Browse Source
This commit is contained in:
Anthony Le Mansec
2010-09-24 17:34:37 +02:00
parent 074a9c845c
commit 54e7ac0ce1
8 changed files with 146 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/bootstrap.php
+22
View File
@@ -1,4 +1,20 @@
<?php
/*
* This file is part of WebAssets for OpenSimulator.
*
* WebAssets for OpenSimulator is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* WebAssets for OpenSimulator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebAssets for OpenSimulator. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file bootstrap.php
* @brief simple autoloader initialization.
@@ -11,6 +27,12 @@ define('ROOT', dirname(__FILE__));
define('CLASSES', ROOT . SEP . 'classes' . SEP);
define('INTERFACES', ROOT . SEP . 'interfaces' . SEP);
/**
* @brief simple autoloader, for our classes and interfaces.
* @details lookups interfaces under 'interfaces/Ifoo.interface.php' (IFoo interface)
* and classes under 'classes/FirstWord/SecondWord.class.php' ('FirstWord_SecondWord' class)
* @throws RuntimeException when requested class/interface is not found.
*/
function __autoload($className) {
// looking for classes :
$classFile = CLASSES . str_replace('_', SEP, $className.'.class.php');
src/classes/Config/Engine.class.php
+16
View File
@@ -1,4 +1,20 @@
<?
/*
* This file is part of WebAssets for OpenSimulator.
*
* WebAssets for OpenSimulator is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* WebAssets for OpenSimulator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebAssets for OpenSimulator. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file Engine.class.php
* @brief Config Engine abstract class declaration
src/classes/Config/Engine/Ini.class.php
+16
View File
@@ -1,4 +1,20 @@
<?php
/*
* This file is part of WebAssets for OpenSimulator.
*
* WebAssets for OpenSimulator is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* WebAssets for OpenSimulator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebAssets for OpenSimulator. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file Ini.class.php
* @brief Config_Engine_Ini class implementation
src/classes/Config/Engine/Xml.class.php
+16
View File
@@ -1,4 +1,20 @@
<?php
/*
* This file is part of WebAssets for OpenSimulator.
*
* WebAssets for OpenSimulator is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* WebAssets for OpenSimulator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebAssets for OpenSimulator. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file Xml.class.php
* @brief Config_Engine_Xml class implementation
src/classes/WebAsset.class.php
+16
View File
@@ -1,4 +1,20 @@
<?php
/*
* This file is part of WebAssets for OpenSimulator.
*
* WebAssets for OpenSimulator is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* WebAssets for OpenSimulator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebAssets for OpenSimulator. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file WebAsset.class.php
* @brief WebAsset class implementation.
src/classes/WebAsset/Viewer.class.php
+23 -1
View File
@@ -1,8 +1,30 @@
<?php
/*
* This file is part of WebAssets for OpenSimulator.
*
* WebAssets for OpenSimulator is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* WebAssets for OpenSimulator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebAssets for OpenSimulator. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @todo implement this :p
*/
class WebAsset_Viewer {
private static $_instance;
private static $_instance; /**< pointer to current instance */
/**
* @brief simple singleton mechanism
* @return (WebAsset_Viewer) newly_created or current instance
*/
public static function instance() {
if (!self::$_instance) {
self::$_instance = new WebAsset_Viewer();
src/interfaces/IConfigEngine.interface.php
+18
View File
@@ -1,5 +1,23 @@
<?php
/*
* This file is part of WebAssets for OpenSimulator.
*
* WebAssets for OpenSimulator is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* WebAssets for OpenSimulator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebAssets for OpenSimulator. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @brief interface describing a ConfigEngine
*/
interface IConfigEngine {
/** @brief loads given config */
src/interfaces/IOpensimAsset.interface.php
+19
View File
@@ -1,5 +1,24 @@
<?php
/*
* This file is part of WebAssets for OpenSimulator.
*
* WebAssets for OpenSimulator is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation.
*
* WebAssets for OpenSimulator is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebAssets for OpenSimulator. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @brief interface representing an opensimulator asser
* @todo add more asset properties/accessors
*/
interface IOpensimAsset {
function setUUID($uuid);