{"id":44445,"date":"2011-07-17T20:26:37","date_gmt":"2011-07-17T20:26:37","guid":{"rendered":"https:\/\/wordpress.org\/plugins-wp\/codex-generator\/"},"modified":"2011-08-06T20:58:57","modified_gmt":"2011-08-06T20:58:57","slug":"codex-generator","status":"closed","type":"plugin","link":"https:\/\/wordpress.org\/plugins\/codex-generator\/","author":910727,"comment_status":"closed","ping_status":"closed","template":"","meta":{"version":"1.2","stable_tag":"1.2","tested":"3.2.1","requires":"3.2.1","requires_php":"","requires_plugins":"","header_name":"Codex Generator","header_author":"Andrey \"Rarst\" Savchenko","header_description":"","assets_banners_color":"","last_updated":"2011-08-06 20:58:57","external_support_url":"","external_repository_url":"","donate_link":"","header_plugin_uri":"http:\/\/wordpress.org\/extend\/plugins\/codex-generator\/","header_author_uri":"http:\/\/www.rarst.net\/","rating":0,"author_block_rating":0,"active_installs":10,"downloads":1614,"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":[],"upgrade_notice":{"1.2":"<p>Considerable interface update. Internal refactoring. Magic.<\/p>","1.1":"<p>Bugs fixed. More magic. Okay - dynamic suggest for function names.<\/p>"},"ratings":{"1":0,"2":0,"3":0,"4":0,"5":0},"assets_icons":[],"assets_banners":[],"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0","1.1","1.2"],"block_files":[],"assets_screenshots":{"screenshot-2.png":{"filename":"screenshot-2.png","revision":"1539359","resolution":"2","location":"plugin"},"screenshot-3.png":{"filename":"screenshot-3.png","revision":"1539359","resolution":"3","location":"plugin"},"screenshot-1.png":{"filename":"screenshot-1.png","revision":"1539359","resolution":"1","location":"plugin"}},"screenshots":{"1":"Using plugin's page in administration area.","2":"Generating markup for wiki page.","3":"Resulting page in Codex."}},"plugin_section":[],"plugin_tags":[6941],"plugin_category":[],"plugin_contributors":[84354],"plugin_business_model":[],"class_list":["post-44445","plugin","type-plugin","status-closed","hentry","plugin_tags-documentation","plugin_contributors-rarst","plugin_committers-rarst"],"banners":[],"icons":{"svg":false,"icon":"https:\/\/s.w.org\/plugins\/geopattern-icon\/codex-generator.svg","icon_2x":false,"generated":true},"screenshots":[{"src":"https:\/\/ps.w.org\/codex-generator\/trunk\/screenshot-1.png?rev=1539359","caption":"Using plugin's page in administration area."},{"src":"https:\/\/ps.w.org\/codex-generator\/trunk\/screenshot-2.png?rev=1539359","caption":"Generating markup for wiki page."},{"src":"https:\/\/ps.w.org\/codex-generator\/trunk\/screenshot-3.png?rev=1539359","caption":"Resulting page in Codex."}],"raw_content":"<!--section=description-->\n<p>Creating page of function reference in Codex involves looking up information about function and dealing with complicated wiki markup.<\/p>\n\n<p>This plugin automates much of the process by reading function's inline documentation and converting to wiki markup:<\/p>\n\n<ul>\n<li>short and long function descriptions<\/li>\n<li>parameters and their default values<\/li>\n<li>version of WordPress function was added in<\/li>\n<li>source file that contains a function<\/li>\n<\/ul>\n\n<p>You can also navigate, search, sort and filter functions by much of that information in plugin's interface.<\/p>\n\n<!--section=installation-->\n<ol>\n<li>Upload <code>codex-generator<\/code> folder to the <code>\/wp-content\/plugins\/<\/code> directory<\/li>\n<li>Activate the plugin through the <code>Plugins<\/code> menu in WordPress<\/li>\n<li>Use plugin's page in WordPress admin area under <code>Tools<\/code> &gt; <code>Codex Generator<\/code><\/li>\n<\/ol>\n\n<p>Note that this plugin <strong>won't work properly with opcode caching enabled<\/strong>. Opcode caching mechanisms (such as APC or eAccelerator) discard PHPDoc data and make it unavailable to plugin.<\/p>\n\n<!--section=faq-->\n<dl>\n<dt>Does it list every single WordPress function?<\/dt>\n<dd><p>Plugin draws data from currently defined functions. It cannot see functions from files that are only loaded in specific cases and inactive plugins.<\/p><\/dd>\n<dt>Why does it complain about opcode caching?<\/dt>\n<dd><p>Opcode caching makes things run snappier and discards non-essential information while at it. So PHPDoc (documentation embedded in source) is not available in that case. And this plugin needs it.<\/p><\/dd>\n<dt>Should I ask my hosting to disable opcode caching?<\/dt>\n<dd><p>Absolutely not! This plugin is mostly meant to be used in development environment. You can run it in production, but you should not compromise performance because of it.<\/p><\/dd>\n\n<\/dl>\n\n<!--section=changelog-->\n<h4>1.2<\/h4>\n\n<ul>\n<li><em>(enhancement)<\/em> added searchable and sortable table of functions to interface<\/li>\n<li><em>(bug fix)<\/em> added spaces when merging multiline short description<\/li>\n<li><em>(internal)<\/em> moved parser to separate class<\/li>\n<li><em>(internal)<\/em> added utility class<\/li>\n<li><em>(internal)<\/em> added function query class<\/li>\n<\/ul>\n\n<h4>1.1<\/h4>\n\n<ul>\n<li><em>(enhancement)<\/em> implemented suggest for function names<\/li>\n<li><em>(enhancement)<\/em> added notice when PHPDoc is not available for a function<\/li>\n<li><em>(enhancement)<\/em> added link to plugin's page in plugin list<\/li>\n<li><em>(bug fix)<\/em> fixed and improved type and value conversion into strings<\/li>\n<li><em>(bug fix)<\/em> changed piped parameter types from \"mixed\" to joined with pipe HTML entity<\/li>\n<li><em>(internal)<\/em> refactored parser<\/li>\n<\/ul>\n\n<h4>1.0<\/h4>\n\n<ul>\n<li>Initial release.<\/li>\n<\/ul>","raw_excerpt":"Codex Generator is search, research and documentation generation tool for WordPress functions.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/44445","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=44445"}],"author":[{"embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/rarst"}],"wp:attachment":[{"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=44445"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=44445"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=44445"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=44445"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=44445"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=44445"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}