doc:articles:updating-markup

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
doc:articles:updating-markup [2009/02/16 22:42]
mgdm created
doc:articles:updating-markup [2017/09/22 13:28] (current)
Line 1: Line 1:
-Updating PHP docs to the new markup+==== Updating PHP docs to the new markup ​====
  
 Several PHP extensions have documentation for OO-style APIs which is written as if the documentation was a procedural API. A good example of this was ext/soap, but also ext/rar seems to be using the old markup too. So, I'm going to take this as my example. If you go to http://​php.net/​rar,​ and look over the methods of the Rar class, you can see they'​re documented just the same as the functions rar_close(),​ rar_entry_get(),​ etc. This isn't handy and makes the search less useful. There is a new variant of the DocBook markup which makes more sense for OO APIs, and it should be converted. This is basically a copy and paste job. Several PHP extensions have documentation for OO-style APIs which is written as if the documentation was a procedural API. A good example of this was ext/soap, but also ext/rar seems to be using the old markup too. So, I'm going to take this as my example. If you go to http://​php.net/​rar,​ and look over the methods of the Rar class, you can see they'​re documented just the same as the functions rar_close(),​ rar_entry_get(),​ etc. This isn't handy and makes the search less useful. There is a new variant of the DocBook markup which makes more sense for OO APIs, and it should be converted. This is basically a copy and paste job.
Line 39: Line 39:
  
 TODO: Describe fixing user notes. TODO: Describe fixing user notes.
 +TODO: Describe how to deal with old CVS history... links to old files should be in the commit message at least.
doc/articles/updating-markup.txt · Last modified: 2017/09/22 13:28 (external edit)