phpDocumentor

TUTORIAL.md

@@ -340,7 +340,17 @@ Documentation and dockblocks
 -------
 You want both your redoc documentation and your code to be readable and reausable to other developers. To this effect we use docblok annotation. You can read more about that [here](https://docs.phpdoc.org/references/phpdoc/basic-syntax.html) but the basic is this, we supply each class and propery with a docblock contained within /\* \* / characters. At the very least we want to describe our properties, the expected results and example data (see the example under [audittrail](#audittrail)
 
-You can generate documantation trough docker-compose exec php php phpDocumentor.phar -d src -t docs
+You can generate documantation trough docker-compose exec php php phpDocumentor.phar -d src -t public/docs
+
+### Adjusting your readme file 
+
+### Using docblocks for in code documentation
+
+### Setting up you Read the Docs page
+
+### Setting up github pages
+
+### Exposing your API documentation
 
 Audittrail
 -------

api/config/packages/security.yaml

@@ -10,12 +10,12 @@ security:
             id: Conduction\CommonGroundBundle\Security\User\CommongroundUserProvider
     firewalls:
         dev:
-            pattern: ^/(_(profiler|wdt)|css|images|js)/
+            pattern: ^/(_(profiler|wdt)|css|images|js|docs)/
             security: false
         # In order to read the docs we must allow anonymous GET reqoust on root    
         docs:
             anonymous: true
-            pattern:  ^/$
+            pattern:  (^/$|^/docs|^/docs/$)
             methods: [GET]
         # The mollie webhook does not have our API key
         webhook:

api/docs/.htaccess

@@ -0,0 +1,5 @@
+# Fixes a vulnerability in CentOS: http://stackoverflow.com/questions/20533279/prevent-php-from-parsing-non-php-files-such-as-somefile-php-txt
+<FilesMatch \.php\.txt$>
+    RemoveHandler .php
+    ForceType text/plain
+</FilesMatch>

api/docs/css/jquery.iviewer.css

@@ -0,0 +1,65 @@
+.viewer {
+    -ms-touch-action: none;
+}
+
+.iviewer_common {
+    position:absolute;
+    bottom:10px;
+    border: 1px  solid #000;
+    height: 28px;
+    z-index: 5000;
+}
+
+.iviewer_cursor {
+    cursor: url(../images/iviewer/hand.cur) 6 8, pointer;
+}
+
+.iviewer_drag_cursor {
+    cursor: url(../images/iviewer/grab.cur) 6 8, pointer;
+}
+
+.iviewer_button {
+    width: 28px;
+    cursor: pointer;
+    background-position: center center;
+    background-repeat: no-repeat;
+}
+
+.iviewer_zoom_in {
+    left: 20px;
+    background: url(../images/iviewer/iviewer.zoom_in.png);
+}
+
+.iviewer_zoom_out {
+    left: 55px;
+    background: url(../images/iviewer/iviewer.zoom_out.png);
+}
+
+.iviewer_zoom_zero {
+    left: 90px;
+    background: url(../images/iviewer/iviewer.zoom_zero.png);
+}
+
+.iviewer_zoom_fit {
+    left: 125px;
+    background: url(../images/iviewer/iviewer.zoom_fit.png);
+}
+
+.iviewer_zoom_status {
+    left: 160px;
+    font: 1em/28px Sans;
+    color: #000;
+    background-color: #fff;
+    text-align: center;
+    width: 60px;
+}
+
+.iviewer_rotate_left {
+    left: 227px;
+    background: #fff url(../images/iviewer/iviewer.rotate_left.png) center center no-repeat;
+}
+
+.iviewer_rotate_right {
+    left: 262px;
+    background: #fff url(../images/iviewer/iviewer.rotate_right.png) center center no-repeat;
+}

api/docs/css/phpdocumentor-clean-icons/Read Me.txt

@@ -0,0 +1,3 @@
+To modify your generated font, use the *dev.svg* file, located in the *fonts* folder in this package. You can import this dev.svg file to the IcoMoon app. All the tags (class names) and the Unicode points of your glyphs are saved in this file.
+
+See the documentation for more info on how to use this package: http://icomoon.io/#docs/font-face

api/docs/css/phpdocumentor-clean-icons/lte-ie7.js

@@ -0,0 +1,30 @@
+/* Load this script using conditional IE comments if you need to support IE 7 and IE 6. */
+
+window.onload = function() {
+	function addIcon(el, entity) {
+		var html = el.innerHTML;
+		el.innerHTML = '<span style="font-family: \'phpdocumentor-clean-icons\'">' + entity + '</span>' + html;
+	}
+	var icons = {
+			'icon-trait' : '&#xe000;',
+			'icon-interface' : '&#xe001;',
+			'icon-class' : '&#xe002;'
+		},
+		els = document.getElementsByTagName('*'),
+		i, attr, html, c, el;
+	for (i = 0; ; i += 1) {
+		el = els[i];
+		if(!el) {
+			break;
+		}
+		attr = el.getAttribute('data-icon');
+		if (attr) {
+			addIcon(el, attr);
+		}
+		c = el.className;
+		c = c.match(/icon-[^\s'"]+/);
+		if (c && icons[c[0]]) {
+			addIcon(el, icons[c[0]]);
+		}
+	}
+};

api/docs/css/phpdocumentor-clean-icons/style.css

@@ -0,0 +1,48 @@
+@font-face {
+	font-family: 'phpdocumentor-clean-icons';
+	src:url('fonts/phpdocumentor-clean-icons.eot');
+	src:url('fonts/phpdocumentor-clean-icons.eot?#iefix') format('embedded-opentype'),
+		url('fonts/phpdocumentor-clean-icons.woff') format('woff'),
+		url('fonts/phpdocumentor-clean-icons.ttf') format('truetype'),
+		url('fonts/phpdocumentor-clean-icons.svg#phpdocumentor-clean-icons') format('svg');
+	font-weight: normal;
+	font-style: normal;
+}
+
+/* Use the following CSS code if you want to use data attributes for inserting your icons */
+[data-icon]:before {
+	font-family: 'phpdocumentor-clean-icons';
+	content: attr(data-icon);
+	speak: none;
+	font-weight: normal;
+	font-variant: normal;
+	text-transform: none;
+	line-height: 1;
+	-webkit-font-smoothing: antialiased;
+}
+
+/* Use the following CSS code if you want to have a class per icon */
+/*
+Instead of a list of all class selectors,
+you can use the generic selector below, but it's slower:
+[class*="icon-"] {
+*/
+.icon-trait, .icon-interface, .icon-class {
+	font-family: 'phpdocumentor-clean-icons';
+	speak: none;
+	font-style: normal;
+	font-weight: normal;
+	font-variant: normal;
+	text-transform: none;
+	line-height: 1;
+	-webkit-font-smoothing: antialiased;
+}
+.icon-trait:before {
+	content: "\e000";
+}
+.icon-interface:before {
+	content: "\e001";
+}
+.icon-class:before {
+	content: "\e002";
+}