Content originally posted in LPCWare by Rob65 on Wed Jun 15 02:28:24 MST 2011
Quote: Thilo
I was under the impression that these files were not written by some Embedded Artists developers but some NXP developers
Yes they are written by NXP, you wrote also:
Quote:
they say that it's a modified version of the sources from NXP
Therefor I just referred to the original NXP code - I can't say anything about modifications that Embedded Artists made.
It seems that is is becoming a standard to place documentation inside the code - and nowhere else. Some programmers use something like autodoc which can extract the documentation from the source code.
I prefer to create separate documentation, having the freedom to include different fonts, diagrams or even flow charts make my documentation so much more understandable. It makes sense to incorporate a message flow diagram in a protocol driver and ascii art is so 1980's :rolleyes:
Sometimes I even use hand written diagrams that I digitize into PDF format. I still find that drawing tools limit my thinking process :D
Most of the NXP application notes contain code next to a PDF file. The PDF file contains the story they want to tell (what the application note is about, what it does and how it works).
Each programmer/organization has its own standards for device drivers and a device driver for FreeRTOS will have a different structure than one for another RTOS or a non-RTOS situation. I once fixed up the I2C driver but already changed it for FreeRTOS - it now even contains a complete task to handle multiple transactions from multiple tasks. so it is hard to define a standard device driver to suit all users.
Regards,
Rob