Chief Delphi

Chief Delphi (http://www.chiefdelphi.com/forums/index.php)
-   C/C++ (http://www.chiefdelphi.com/forums/forumdisplay.php?f=183)
-   -   WPI Library Documentation -- Local Copy? (http://www.chiefdelphi.com/forums/showthread.php?t=133453)

mandrews281 01-24-2015 02:24 PM

WPI Library Documentation -- Local Copy?
 
I really miss having the WPI library documentation on the local machine this year. When your programming laptop is connected to the robot for debugging, it doesn't have internet access to get online documentation.

Has anyone generated (or can explain how to generate) a standalone 2015 WPILib.chm file yet?

WPILib team (if you're listening), please make this a priority for the next update. Pretty please?

ttedrow 01-24-2015 03:08 PM

Re: WPI Library Documentation -- Local Copy?
 
Second the motion:]

mandrews281 01-25-2015 03:18 PM

Re: WPI Library Documentation -- Local Copy?
 
1 Attachment(s)
OK I downloaded doxygen and MS HTML Help Workshop and generated a file myself. Pointed it at the include directory and voila (see attached file).

It's a bit of a mess since I've never worked with doxygen before (lots of extra structures that were in the include files but are not meant for direct use by the programmer); but it's a start.

Does anyone have a decent doxyfile that will cut down on the output?

Joe Ross 01-25-2015 03:51 PM

Re: WPI Library Documentation -- Local Copy?
 
The doxy file that WPI uses is here: https://usfirst.collab.net/gerrit/gi...da2 3;hb=HEAD

mandrews281 01-25-2015 04:57 PM

Re: WPI Library Documentation -- Local Copy?
 
1 Attachment(s)
Much better. There were a couple of excludes in there that cleaned things up nicely. Here's the updated file everyone. Enjoy (I am).

I didn't know WPILib moved to CollabNet (from FIRSTForge). I was going to complain about the source not being available next :D .

ThomasClark 01-29-2015 10:10 PM

Re: WPI Library Documentation -- Local Copy?
 
The documentation is already on your computer. It's in $HOME/wpilib/java/current/javadoc/index.html.

RufflesRidge 01-29-2015 10:14 PM

Re: WPI Library Documentation -- Local Copy?
 
Quote:

Originally Posted by ThomasClark (Post 1435919)
The documentation is already on your computer. It's in $HOME/wpilib/java/current/javadoc/index.html.

That's for java...

gwlund 01-30-2015 12:31 AM

Re: WPI Library Documentation -- Local Copy?
 
Thanks. Don't forget to let everyone know that MS Windows blocks CHM help files from unknown sources. Click the file properties and click the Unblock button to get the content to display.

ThomasClark 01-30-2015 05:20 PM

Re: WPI Library Documentation -- Local Copy?
 
Quote:

Originally Posted by RufflesRidge (Post 1435920)
That's for java...

Doesn't matter. It's the same library, but with camel case method names.

RufflesRidge 01-30-2015 05:40 PM

Re: WPI Library Documentation -- Local Copy?
 
Quote:

Originally Posted by ThomasClark (Post 1436284)
Doesn't matter. It's the same library, but with camel case method names.

Even if the API was 100% identical (which I'm not sure it is) my point was that if you don't install the Java plugin, because you're not programming in Java, you won't have that folder at all.

JohnGaby 07-26-2015 11:59 PM

Re: WPI Library Documentation -- Local Copy?
 
I know this is an old thread, but I just downloaded both versions of 2015_WPILib.zip and although I can open the 2015_WPILib.chm file and see the list of topics, I cannot get any of the topics to display. Does anyone have any idea why this might be?

Thanks.


All times are GMT -5. The time now is 10:50 AM.

Powered by vBulletin® Version 3.6.4
Copyright ©2000 - 2017, Jelsoft Enterprises Ltd.
Copyright © Chief Delphi