Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
401 commits 8 branches 1 tag 12 MiB
Commit graph

11 commits

Author SHA1 Message Date
VirtualTam
05af6f5325 Add a target to generate Doxygen documentation 
Relates to #95

Customizations for PHP/Shaarli:
 - add project information
 - index PHP files
 - index global functions
 - exclude directories

Usage
 $ make doxygen
 $ firefox doxygen/index.html &

Notes
 - classes can be found under "Data Structures"
 - global functions can be found under "Files > Globals > Functions"

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2015-11-22 20:35:00 +01:00
ArthurHoaro
a52e843593 Add plugins folder to test analysis 2015-11-07 15:27:22 +01:00
VirtualTam
992af0b9d7 Doc: sync from Wiki, generate HTML 
Closes #291
Fixes #227

Modifications
 - HTML content: match the new Wiki structure
 - Makefile
   - generate a custom HTML sidebar
   - include the sidebar on all pages
   - infer and prepend page titles
   - handle relative links
   - add title metadata, e.g. Shaarli - <Page Name>

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2015-08-04 16:02:21 +02:00
VirtualTam
96db105e4c Merge pull request #276 from virtualtam/tools/phpcs 
Add a generic rule to run PHPCS against different coding standards
 2015-07-31 16:08:32 +02:00
VirtualTam
d0ce99e59e Makefile: do not call clean before test 
Fixes #288

Modifications:
 - call `make clean` explicitely to clean the workspace
 - add `make clean` to Travis instructions

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2015-07-18 13:43:19 +02:00
VirtualTam
3e25f245f9 Makefile: add a generic rule to run PHPCS against different coding standards 
Relates to #95

Usage
 - list available standards
   $ ./vendor/bin/phpcs -i
 - run PHPCS against a given standard
   $ make PHPCS_<standard>

Examples
 $ make PHPCS_PSR1
 $ make PHPCS_Zend

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2015-07-12 23:04:43 +02:00
VirtualTam
ca74886f30 LinkDB: move to a proper file, add test coverage 
Relates to #71

LinkDB
 - move to application/LinkDB.php
 - code cleanup
   - indentation
   - whitespaces
   - formatting
 - comment cleanup
   - add missing documentation
   - unify formatting

Test coverage for LinkDB
 - constructor
 - public / private access
 - link-related methods

Shaarli utilities (LinkDB dependencies)
 - move startsWith() and endsWith() functions to application/Utils.php
 - add test coverage

Dev utilities
 - Composer: add PHPUnit to dev dependencies
 - Makefile:
    - update lint targets
    - add test targets
    - generate coverage reports

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
 2015-06-11 00:45:45 +02:00
nodiscc
82af78b272 use pandoc to generate local HTML documentation 
fixes https://github.com/shaarli/Shaarli/issues/178
run 'make htmldoc'
 2015-04-05 22:35:01 +02:00
nodiscc
f3e89f50ec cleanup: makefile comments 2015-04-05 22:17:37 +02:00
nodiscc
1acc87eeac Include documentation/wiki locally: 
* sync current wiki (https://github.com/shaarli/Shaarli/wiki) to the doc/ directory
 * fix missing logo in README
 * add link to local documentation in the page footer
 * add Makefile targets for doc generation by @virtualtam
 2015-03-14 18:40:11 +01:00
VirtualTam
00f98bdaca Code quality: Makefile to run static code checkers 
Relates to #71
Relates to #95

Additions:
- Makefile for easy usage,
- Composer file to declare dev & test dependencies.

Features:
- PHP Copy/Paste Detect: detect duplicate code;
- PHP Code Sniffer: static analysis, syntax checking,
- PHP Mess Detector: static analysis, syntax checking.

Signed-off-by: VirtualTam <virtualtam@flibidi.org>
 2015-03-05 23:28:43 +01:00