TheEnd
Posts: 6
Joined: Sat Apr 15, 2006 10:40 pm

Xml Documentation !

Sat Apr 15, 2006 10:48 pm

Hi all,

I'm wondering why there is no XML documentations in the library?!

It's simple, just add this (for class, method, property) :

/// <summary>
/// Reads the current stream of bla bla!
/// </summary>
public int Read(Stream stream)
{
}

It's really helping the developer to fast understand the method or the class..!

Regards

User avatar
johan
GpsGate
Posts: 15423
Joined: Wed Aug 04, 2004 10:40 pm
Location: Sweden
Contact: Website

RE: Xml Documentation !

Sun Apr 16, 2006 2:17 pm

There is "XML" docs.

If you download and install the SDK, you will find "XML" docs under Start -> Program -> Franson BlueTools SDK"

You can also find web based XML docs here:
http://franson.com/bluetools/reference_manual.asp?platform=net

Regards,
Johan

Franson Support

TheEnd
Posts: 6
Joined: Sat Apr 15, 2006 10:40 pm

RE: Xml Documentation !

Sun Apr 16, 2006 4:05 pm

Thanks, but i couldn't find it!
Start -> All Programs -> Franson BlueTools SDK v1.1 ->
Has just 4 folders: .NET 2 and 1, Copmact 2 and 1..
And three CHM help files.. not XML files
I coludn't find any xml files..!

Thanks again,
Regards

TheEnd
Posts: 6
Joined: Sat Apr 15, 2006 10:40 pm

RE: Xml Documentation !

Sun Apr 16, 2006 4:09 pm

My point is to help the developer while he/she is writing the code..
I know there is documenations.. but I ment the one inside the VS to help you coding better..!

Sorry if there is any misunderstandign..
Regards

User avatar
johan
GpsGate
Posts: 15423
Joined: Wed Aug 04, 2004 10:40 pm
Location: Sweden
Contact: Website

RE: Xml Documentation !

Sun Apr 16, 2006 4:12 pm

I mean the CHM files as well. They are generated they way you suggest. The help files are not integrated into Visual Studio if that was what you were asking for. However they do have the look and feel of standard .NET documentation.

Regards,
Johan

Franson Support

TheEnd
Posts: 6
Joined: Sat Apr 15, 2006 10:40 pm

RE: Xml Documentation !

Sun Apr 16, 2006 11:12 pm

Thanks..
Why you didn't check the 'Xml Documentation' checkbox bedore building :) It was gonna be nice feature!

Regards,

Return to “BlueTools”