phpdoc changes for api generation

Dieser Commit ist enthalten in:
o.pinke 2021-01-26 19:41:21 +01:00
Ursprung 586188c2cc
Commit c4fa8aae5b
10 geänderte Dateien mit 256 neuen und 296 gelöschten Zeilen

Datei anzeigen

@ -6,7 +6,9 @@
* Description: * Description:
* Base Class for all cHTML Elements * Base Class for all cHTML Elements
* *
* @package ConLite\Core\cHTML5 * @category ConLite
* @package Core
* @subpackage cHTML
* @since 2.0 * @since 2.0
* @author Ortwin Pinke <o.pinke@conlite.org> * @author Ortwin Pinke <o.pinke@conlite.org>
* @copyright (c) 2012, conlite.org * @copyright (c) 2012, conlite.org

Datei anzeigen

@ -6,7 +6,9 @@
* Description: * Description:
* cHTML Meta * cHTML Meta
* *
* @package ConLite\Core\cHTML5 * @category ConLite
* @package Core
* @subpackage cHTML
* @since 2.0 * @since 2.0
* @author Ortwin Pinke <o.pinke@conlite.org> * @author Ortwin Pinke <o.pinke@conlite.org>
* @copyright (c) 2015, conlite.org * @copyright (c) 2015, conlite.org

Datei anzeigen

@ -7,7 +7,9 @@
* Description: * Description:
* cHTML List Element * cHTML List Element
* *
* @package ConLite\Core\cHTML5 * @category ConLite
* @package Core
* @subpackage cHTML
* @since 2.0 * @since 2.0
* @author Ortwin Pinke <o.pinke@conlite.org> * @author Ortwin Pinke <o.pinke@conlite.org>
* @copyright (c) 2015, conlite.org * @copyright (c) 2015, conlite.org

Datei anzeigen

@ -6,7 +6,9 @@
* Description: * Description:
* cHTML List * cHTML List
* *
* @package ConLite\Core\cHTML5 * @category ConLite
* @package Core
* @subpackage cHTML
* @since 2.0 * @since 2.0
* @author Ortwin Pinke <o.pinke@conlite.org> * @author Ortwin Pinke <o.pinke@conlite.org>
* @copyright (c) 2015, conlite.org * @copyright (c) 2015, conlite.org

Datei anzeigen

@ -6,7 +6,9 @@
* Description: * Description:
* cHTML Meta * cHTML Meta
* *
* @package ConLite\Core\cHTML5 * @category ConLite
* @package Core
* @subpackage cHTML
* @since 2.0 * @since 2.0
* @author Ortwin Pinke <o.pinke@conlite.org> * @author Ortwin Pinke <o.pinke@conlite.org>
* @copyright (c) 2015, conlite.org * @copyright (c) 2015, conlite.org

Datei anzeigen

@ -1,7 +1,28 @@
<?php <?php
/**
* Article Collector Class
*
* This is an helper class to collect articles for article list etc.
*
* @category ConLite
* @package Core
* @subpackage clHelper
* @since 2.1
* @author Ortwin Pinke <o.pinke@conlite.org>
* @copyright (c) 2019, conlite.org
* @license http://www.gnu.de/documents/gpl.en.html GPL v3 (english version)
* @license http://www.gnu.de/documents/gpl.de.html GPL v3 (deutsche Version)
* @link http://www.conlite.org ConLite.org
*/
defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.'); defined('CON_FRAMEWORK') || die('Illegal call: Missing framework initialization - request aborted.');
/**
* Class Article Collector
*
* @author Ortwin Pinke <o.pinke@conlite.org>
*/
class cArticleCollector implements SeekableIterator, Countable { class cArticleCollector implements SeekableIterator, Countable {
/** /**

Datei-Diff unterdrückt, da er zu groß ist Diff laden

Datei anzeigen

@ -10,7 +10,8 @@
* @con_php_req 5.0 * @con_php_req 5.0
* *
* *
* @package Contenido Backend includes * @package Core
* @subpackage Backend
* @version 1.0.2 * @version 1.0.2
* @author Timo A. Hummel * @author Timo A. Hummel
* @copyright four for business AG <www.4fb.de> * @copyright four for business AG <www.4fb.de>

31
phpdoc.dist.xml Normale Datei
Datei anzeigen

@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
configVersion="3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://www.phpdoc.org"
xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
>
<title>CMS ConLite</title>
<template name="responsive-twig"/>
<paths>
<output>_api</output>
<cache>_api/cache</cache>
</paths>
<version number="2.1.1">
<api>
<source dsn=".">
<path>conlite</path>
<path>setup</path>
<path>conlib</path>
</source>
<ignore hidden="true" symlinks="true">
<path>conlite/plugins/**/*</path>
<path>conlite/external/**/*</path>
</ignore>
<extensions>
<extension>php</extension>
</extensions>
<default-package-name>ConLite</default-package-name>
</api>
</version>
</phpdocumentor>

Datei anzeigen

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
<title>API ConLite 2.1.1</title>
<parser>
<target>_api</target>
</parser>
<transformer>
<target>_api</target>
</transformer>
<files>
<directory>conlib</directory>
<directory>conlite</directory>
<ignore>plugins/*</ignore>
<ignore>external/*</ignore>
</files>
<transformations>
<template name="responsive" />
</transformations>
</phpdoc>