Documentation
Started by QuantumPhysGuy, Oct 17 2012 03:55 PM
8 replies to this topic
#1
QuantumPhysGuy
-
- Members
-
- 30 posts
Advanced Member
- LocationKentucky, USA
Posted 17 October 2012 - 03:55 PM
I'm not sure where else to post this, but after talking to a few people I've noticed one of the things that the Netduino SDK lacks is documentation. I think I am going to take on the task of creating XML documentation for all the classes, methods, properties, and events from the Netduino SDK. Once I'm done I'll be able to export the XML documentation as a CHM and HTML documentation for the Netduino SDK/API.
Here's hoping everything works out.
#2
CW2
-
- Members
-
- 1592 posts
Advanced Member
- LocationCzech Republic
Posted 17 October 2012 - 04:45 PM
.NET Micro Framework SDK documentation is available on MSDN (API Reference). However, it does not include vendor-specific libraries (SecretLabs.*).
#3
neslekkim
-
- Members
-
- 350 posts
Advanced Member
- LocationOslo, Norway
Posted 17 October 2012 - 06:07 PM
Are you really going to create bolt-on documentation?, if documentation was done in the sourcecode using xmldoc, then it could be extracted, and since secretlabs don't have any public repo, you need to do it on your own copy of the source, and loose it with next version..
But it would have been nice if it was there..
--
Asbjørn
#4
QuantumPhysGuy
-
- Members
-
- 30 posts
Advanced Member
- LocationKentucky, USA
Posted 17 October 2012 - 06:22 PM
Are you really going to create bolt-on documentation?, if documentation was done in the sourcecode using xmldoc, then it could be extracted, and since secretlabs don't have any public repo, you need to do it on your own copy of the source, and loose it with next version..
But it would have been nice if it was there..
That's currently what I am doing. Major problem is NETMF doesn't support XMLDoc imbedded in the DLLs fully due to size. So, I'm have to have VS2010 generate the xml files per library and import them into sandcastle.
It should be easy to migrate each exported XML over to the new versions of the SDK when they are released. Sandcastle would then flag which methods aren't documented and I can fix from there.
#5
neslekkim
-
- Members
-
- 350 posts
Advanced Member
- LocationOslo, Norway
Posted 17 October 2012 - 06:30 PM
Xmldoc is newer embedded in the dll files, you write it in the source, as comments.. I guess you know that?
The compiler will extract that as xml files placed next to the dll file, so you can get inline docs, or create chm docs.
--
Asbjørn
#6
QuantumPhysGuy
-
- Members
-
- 30 posts
Advanced Member
- LocationKentucky, USA
Posted 17 October 2012 - 06:39 PM
Xmldoc is newer embedded in the dll files, you write it in the source, as comments.. I guess you know that?
The compiler will extract that as xml files placed next to the dll file, so you can get inline docs, or create chm docs.
Yes I know that. NETMF doesn't support, all the way, the embedding of the XML comments due to size. Just had that issue. So I am telling the VS2010 compiler, by checking "XML Documentation File" in the Build properties of each SecretLabs project, then using Sand Castle to compile it all to an CHM format and HTML format.
#7
awaiK
-
- Members
-
- 90 posts
Advanced Member
Posted 27 October 2012 - 10:32 AM
The netduino SDK definitely lacks documentation.
#8
Chris Walker
-
- Moderators
-
- 7767 posts
Secret Labs Staff
- LocationNew York, NY
Posted 27 October 2012 - 04:42 PM
Hi awaiK,
What kind of additional documentation would you like to see? We only have two rarely-used functions in the Netduino SDK these days (MountSD and DeploymentTransport), but we're going to be adding more soon.
Are you looking mostly for more documentation on NETMF (99% of the features--which have a reference guide) or for details on MountSD/DeploymentTransport? We could certainly integrate Sandcastle into our build process.
Chris
- Arron Chapman likes this
#9
awaiK
-
- Members
-
- 90 posts
Advanced Member
Posted 27 October 2012 - 06:28 PM
Hi Chris,
I was wrong. I should express myself more precisely.
What I'm missing are XML documentation comments (XML Documentation Comments) for NETMF classes.
Moreover: Sometimes I whish I had more information about PWM on netduino like the range of frequency, duty cycle, etc. which is possible on netduino hardware. I'm not that familiar with PWM, maybe this information is availabe but I'm not able to interpret it.
I was wrong. I should express myself more precisely.
What I'm missing are XML documentation comments (XML Documentation Comments) for NETMF classes.
Moreover: Sometimes I whish I had more information about PWM on netduino like the range of frequency, duty cycle, etc. which is possible on netduino hardware. I'm not that familiar with PWM, maybe this information is availabe but I'm not able to interpret it.
0 user(s) are reading this topic
0 members, 0 guests, 0 anonymous users
