tyler.durden/icingaweb2
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2.git synced 2025-10-30 19:04:10 +01:00
Code Issues Packages Projects Releases Wiki Activity
7,467 Commits 137 Branches 76 Tags
Commit Graph

36 Commits

Author SHA1 Message Date
Eric Lippmann
8563d5ed3f PHPDoc: Use @var instead of @type 
Becasue of too many kittens PSR-5 backed off of deprecating @var.
So that's the way we go too.
 2015-03-12 16:08:47 +01:00
Eric Lippmann
310201eb5b doc/lib: Throw LogicException if text is added without having a heading 2015-02-11 15:51:31 +01:00
Eric Lippmann
d2520f1286 doc/lib: Prefer @type over @var in the DocParser 
refs #6630
 2015-02-11 13:02:33 +01:00
Eric Lippmann
c95838a33d doc/lib: Use SimpleTree in the DocParser 
refs #6630
 2015-02-10 17:04:27 +01:00
Eric Lippmann
6bae2e0a53 Note that our license is GPL v2 or any later version in our license header instead of pointing to the license's URL 2015-02-04 10:52:27 +01:00
Eric Lippmann
5b4fab0750 Add license header 
This time without syntax errors hopefully :)
 2015-02-03 16:27:59 +01:00
Eric Lippmann
5fa2e3cfdc Revert "Add license header" 
This reverts commit 338d067aba41dd6e9178cebec5433eecd614196e.
 2015-02-03 16:16:26 +01:00
Eric Lippmann
338d067aba Add license header 
fixes #7788
 2015-02-03 15:51:04 +01:00
Eric Lippmann
40b7098480 doc/parser: Fix PHPDoc indentation 2014-12-09 14:24:11 +01:00
Eric Lippmann
8c02f140c3 doc: fix translate calls w/ sprintf 2014-08-19 16:22:54 +02:00
Eric Lippmann
d35e0816c9 doc: use `sprintf' in exceptions 
refs #4820
 2014-08-19 13:20:46 +02:00
Eric Lippmann
cb17590b71 doc: rename nofollow' to noFollow' 
refs #4820
 2014-08-19 09:57:22 +02:00
Eric Lippmann
289aed8420 doc: Use chapterId' instead of chapterTitle' in URLs 
Manually given chapter IDs are meant to not change while a chapter's title could change.

refs #4820
 2014-08-19 09:45:53 +02:00
Eric Lippmann
3cafc8910a doc/DocParser: Rename 'header' to 'title' 
refs #4820
 2014-07-29 11:12:06 +02:00
Eric Lippmann
38a6df91b9 doc/DocParser: Rename 'chapterName' to 'chapterTitle' 
refs #4820
 2014-07-29 11:10:49 +02:00
Eric Lippmann
134db3fc66 doc/DocParser: Replace getDoc()' and getToc()' with `getDocTree()' 
refs #4820
 2014-07-28 19:09:04 +02:00
Eric Lippmann
1bbfa9b9ca doc module: Let DocParser' throw DocEmptyException' and `ChapterNotFound' exception 
`DocEmptyException' is thrown during construction when a documentation directory is empty.
`ChapterNotFound' is thrown when a chapter was not found when calling `getChapter()'.

refs #4820
 2014-06-30 15:24:40 +02:00
Eric Lippmann
8fe1d49ce9 doc/cs: Begin additional if conditions on a new line 2014-06-13 17:23:20 +02:00
Eric Lippmann
160a75403d Merge branch 'master' into feature/display-documentation-4820 
Conflicts:
	modules/doc/library/Doc/DocParser.php
 2014-06-06 14:25:13 +02:00
Eric Lippmann
d446e0db2e doc: Implement DocParser::getChapter() 
refs #4820
 2014-06-06 14:12:30 +02:00
Thomas Gelf
c592236258 vendorlibs: library/vendor to libary/IcingaVendor 
This doesn't make it much better but allows to build a package
libicinga-vendor-php placing those files to /usr/share/php/IcingaVendor
or similar.

refs #4075
 2014-06-05 00:10:49 +00:00
Eric Lippmann
d5cf2f2472 doc: Implement `DocParser::getToc()' 
refs #4820
 2014-06-03 15:23:59 +02:00
Eric Lippmann
ed8de18ad5 DocParser: Use first header in a file as section title 
refs #4820
 2014-06-03 14:56:44 +02:00
Eric Lippmann
370bfca6e6 DocParser: Remove itemPriority since it's nowhere used 
refs #4820
 2014-06-03 14:53:28 +02:00
Eric Lippmann
d3a9f17fc2 doc/parser: Return the DocTocHtmlRenderer instead of an array 
refs #4820
 2014-05-28 17:18:07 +02:00
Eric Lippmann
6ce739e23d Doc: Construct parser with the path to the documentation 
Before, the parser decided which path to used based on a given module name.
Now, the parser requires the path to the documentation.
Further the toc items no longer include a URL. The must URL must be generated
from a render function or view script.

refs #4820
 2014-05-27 15:12:06 +02:00
Eric Lippmann
5923622fb8 modules/doc: Fix toc links 
The DocParser generates toc links with a hard-coded URL. This should
be changed to be generated from a route. But we did not decide how
to handle route overrides yet.

refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann
89bddb10e7 modules/doc: Tell which doc directory does not exist, in case it does not exist :) 
Thanks Michael

refs #4820
 2014-05-27 15:11:33 +02:00
Eric Lippmann
99971e241c modules/doc: Replace Parsedown's decprecated method parse() with text() 
refs #4820
 2014-05-27 15:11:32 +02:00
Eric Lippmann
e6abe21fb8 modules/doc: Rename DocParser::getDocumentation() to getDocAndToc() 
refs #4820
 2014-05-27 15:11:32 +02:00
Thomas Gelf
d326b3b683 Get documentation module ready for release, first steps 2014-03-21 19:05:00 +00:00
Eric Lippmann
5a913881a6 Modules/Doc: Add Syntax highlighting for PHP code 
refs #4820
 2014-02-11 17:04:58 +01:00
Eric Lippmann
7f099b211b Fix documentation 
refs #4820
 2014-02-11 16:35:36 +01:00
Eric Lippmann
1caacbf20f Modules/Doc: Set rel="nofollow" on header links missing a user-specified id 
refs #4820
 2014-02-11 15:27:42 +01:00
Eric Lippmann
f96974fc79 Modules/Doc: Use Icinga\Web\Menu for the toc 
refs #4820
 2014-02-11 15:13:18 +01:00
Eric Lippmann
88e13c378d Modules/Doc: Add doc display per module 
refs #4820
 2014-02-11 15:09:04 +01:00