Email: Password: Remember Me | Create Account (Free)

Back to Subject List

Old thread has been locked -- no new posts accepted in this thread
???
07/06/10 13:49
Read: times


 
#177115 - php and html when documenting
Responding to: ???'s previous message
I use a lot of HTML for documentation.

On one hand, I can produce XHTML that may be imported into Word and then further into nice page-breaked pdf files.

On the other hand, I may use php to auto-generate the HTML, allowing me to store information in either a flat text file or a MySQL database.

I also try to incorporate tags into the source code to allow specific conditions in the code to be mapped to specific requirements.

Anyone used Doxygen together with graphing of relations? Unix have a nice set of tools that can read text files and auto-create graphs showing relations between states or objects. And even if you don't have 100% control of the layout, it is very easy to produce the text files and have the tool compute a suitable layout.

One of the advantages with php is that it not only can be used to produce documentation - it can also be used as a prototyping language to test different things - and the large availability of library functions/classes means that the output from simulations can be easily presented in a suitable form, while at the same time input parameters can be harvested/retrieved from other systems or from files or images...

List of 29 messages in thread
TopicAuthorDate
Uart user menu via switch/case state machine            01/01/70 00:00      
   State machine can be small.            01/01/70 00:00      
   My take....            01/01/70 00:00      
   asked and answered            01/01/70 00:00      
      Broken and Fixed            01/01/70 00:00      
         excellent            01/01/70 00:00      
            My experience as well....            01/01/70 00:00      
               My experience as well....            01/01/70 00:00      
               But you're the writer...            01/01/70 00:00      
                  out of context            01/01/70 00:00      
                     Yes, Chances are no one else will see your code            01/01/70 00:00      
                        male cow manure            01/01/70 00:00      
                           Don't be too over confident            01/01/70 00:00      
                  Just Concepts            01/01/70 00:00      
                     Don't think own code is the best            01/01/70 00:00      
                     exactly            01/01/70 00:00      
                        what I have done a lot of lately is            01/01/70 00:00      
   Protothreads???            01/01/70 00:00      
   A case for a CASE tool?            01/01/70 00:00      
      Using a tool like that........            01/01/70 00:00      
         Thanks Michael...            01/01/70 00:00      
            Pencil and paper            01/01/70 00:00      
      Pros and Cons            01/01/70 00:00      
         Analysis/Design            01/01/70 00:00      
            Enterprise Architect            01/01/70 00:00      
               RE: Enterprise Architect            01/01/70 00:00      
                  Reverse State Tables            01/01/70 00:00      
                     RE: "Reverse-engineering"            01/01/70 00:00      
                        php and html when documenting            01/01/70 00:00      

Back to Subject List