tonyair/silverstripe-reports
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-reports synced 2024-10-22 11:05:53 +02:00
Code Issues Projects Releases Wiki Activity

MINOR Moved class-specific documentation from doc.silverstripe.org back into class-level PHPDoc

Browse Source 
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/branches/2.4@107726 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2010-07-11 10:46:12 +00:00 committed by Sam Minnee
parent b505c5540a
commit 8c43535225
2 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
code/CMSMenu.php
View File

@ -1,7 +1,10 @@
<?php <?php
/** /**
* The object manages the main CMS menu. * The object manages the main CMS menu. See {@link LeftAndMain::init()} for example usage.
* See {@link LeftAndMain::init()} for example usage. *
* The menu will be automatically populated with menu items for subclasses of {@link LeftAndMain}.
* That is, for each class in the CMS that creates an administration panel, a CMS menu item will be created.
* The default configuration will also include a 'help' link to the SilverStripe user documentation.
* *
* @package cms * @package cms
* @subpackage content * @subpackage content

12
code/StaticExporter.php
View File

@ -4,8 +4,16 @@
* It creates a huge number of folders each containing an index.html file. * It creates a huge number of folders each containing an index.html file.
* This preserves the URL naming format. * This preserves the URL naming format.
* *
* Requirements: Unix Filesystem supporting symlinking. * Requirements: Unix Filesystem supporting symlinking. Doesn't work on Windows.
* Doesn't work on Windows. *
* <b>Usage</b>
*
* The exporter can only be invoked through a URL. Usage on commandline (through [sake](sake)) is not possible at the moment, as we're sending a file to the browser for download.
*
* <pre>http://localhost/StaticExporter/export</pre>
*
* Specify a custom baseurl in case you want to deploy the static HTML pages on a different host:
* <pre>http://localhost/StaticExporter/export?baseurl=http://example.com</pre>
* *
* @see StaticPublisher * @see StaticPublisher
* *