phpdoc - Generate PHP Documentation for different access levels -


i'm working in php project needs generate 3 or more documentations, ones more restrictive others. documentation, use phpdocumentor 2. way i've found 2 level of documentation, using @internal tag , --parseprivate option (for generate private documentation).

is posible generate third documentation intermediate restriction level?

i've tried @access tag --visibility, doesn't work in version 2 of phpdocumentor. or @ignore tag, didn't found way generate third documentation code setted tag.

the @access tag defunct php4 tag, use before actual visibility keywords added php5. phpdocumentor 1.x recognize tags, if keywords in code, tags ignored. 2.x doesn't bother tags anymore.

"intermediate level" rather arbitrary description. 3 "levels" here need particular requirements spelled out, , best managed 3 different phpdoc.xml configuration files.

here's example of how might describe 3 levels of docs, , how i'd accomplish them.

api-level: i'd use file-based argument document interfaces. if @api tag used in docblocks denote actual individual pieces of public api, rely on those. however, think presentation of info in documentation highlighting sidebar, whereas approach of documenting interfaces means whole document solely defined interfaces (which presume "the api").

app-level: i'd capture classes, go default behavior of showing public visibility components.

dev-level: i'd use --parseprivate show components. tend put developer-targeted information @internal tags myself.

again, i'd use customized phpdoc.xml config files each of these, definitions committed version control.


Comments

Post a Comment

Popular posts from this blog

php - Vagrant up error - Uncaught Reflection Exception: Class DOMDocument does not exist -

i've set bento/ubuntu-16.04 vagrant box using php 5.6, , getting following error quite few times when try , run shell script: "uncaught reflection exception: class domdocument not exist". i've tried adding following top of script (not together), each no success: "sudo apt-get install php5.6-xml", "sudo apt-get install php5-xml", "sudo apt-get install php-dom" i've tried resetting server "sudo service apache2 restart". does have suggestions?
Read more

vue.js - Create hooks for automated testing -

Image
qa guys complained can't automate frontend testing. because our html looks same outside. lazy hack did this <template> <div :role="$options.name"> ... </div> </template> <script> export default { name: 'vmcomponentname' } </script> which takes name script , applies html. in browser get: <div role="vmcomponentname"> ... </div> line :role="$options.name" goes in every component. is there dry er solutions? please share. additional details i'll explain in details looking for. imagine have vmusercreate form creates user. test case can create user . to automatically test without role, have use following selector: .wrapper > .wrapper > .wrapper > .submit-button the test extremely brittle (will break lot). if use roles can use [role="vmusercreateform"] .submit-button selector. many folds less brittle. so basically, i'm ...
Read more

Add new key value to json node in java -

i have json file : { "id":1, "name":"abc", "addressdetails": { "city":"newyork" } } i wanted add 1 more key-value ("pincode" : "414141") node 'addressdetails'. i tried using : objectmapper mapper = new objectmapper(); jsonnode root = mapper.readtree(new file("d://test.json")); objectnode node = mapper.createobjectnode(); node.with("addressdetails").put("pincode", "414141"); but it's not getting added, there way can ? you can try you should modify file path objectmapper mapper = new objectmapper(); objectnode nodes = mapper.readvalue(new file("d:\\test.txt"), objectnode.class); nodes.with("addressdetails").put("pincode", "414141"); mapper.writer().writevalue(new file("d:\\test.txt"), nodes);
Read more