Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [linuxtools-dev] pondering moving sdl / opengl docs into libhover 
Hi guys,

I was braving the libhover learning curve a bit more this weekend.
You previously mentioned that there were existing tools to parse&convert certain help-doc types into the xml format (texinfo? gtk-doc?). Can I learn a bit more info on these techniques. Which tools are they? Where to find? How to use? 

Cheers,
Gurce


On 26/10/12 08:45, Gurce Isikyildiz wrote:

Thanks Jeff,

This worked fine. I'll press on with it then.

Cheers,
Gurce


On 26/10/12 03:18, Jeff Johnston wrote:

Point the classpath to the jar files in the Eclipse plugins directory:
e.g. java -cp '/notnfs/jjohnstn/eclipse-4.2/eclipse/plugins/*' org.eclipse.linuxtools.cdt.libhover.utils.BuildFunctionInfos
Note the quote so your command line doesn't try expanding the * and then complains about not finding any main class: xxxxxx.jar
The main function requires some arguments passed to it or you will see a failure. See the java file for more info. 

-- Jeff J.

On 10/24/2012 07:48 PM, Gurce Isikyildiz wrote:

Hi Jeff,

Thanks for the link, I've downloaded the source now.

My next Q:

 > C Library Hover Utility: ... Run the file as a Java application (it
has a static main method) and pass to it two parameters:
I'm unsure how to run the "BuildFunctionInfos" utility mentioned here. I 
made the following attempts:

  * Attempt 1:

    cd bin/org/eclipse/linuxtools/cdt/libhover/utils/
    java BuildFunctionInfos

    Exception in thread "main" java.lang.NoClassDefFoundError:
    BuildFunctionInfos (wrong name:
org/eclipse/linuxtools/cdt/libhover/utils/BuildFunctionInfos)

  * Attempt 2:

    cd ~/eclipse/plugins
    java -cp java -cp
    org.eclipse.linuxtools.cdt.libhover_1.2.0.201209191645.jar
org.eclipse.linuxtools.cdt.libhover.utils.BuildFunctionInfos

  * Attempt 3:

    cd bin/org/eclipse/linuxtools/cdt/libhover/utils/
    java -cp ..:. BuildFunctionInfos

    java -cp ..:.
org.eclipse.linuxtools.cdt.libhover.utils.BuildFunctionInfos
    Exception in thread "main" java.lang.NoClassDefFoundError:
org/eclipse/linuxtools/cdt/libhover/utils/BuildFunctionInfos
    Caused by: java.lang.ClassNotFoundException:
org.eclipse.linuxtools.cdt.libhover.utils.BuildFunctionInfos
             at java.net.URLClassLoader$1.run(URLClassLoader.java:217)


  * Attempt 4:

    I tried running it from within eclipse via a debug launcher. Seems
    to work ok this way, but it still puzzles me as to what is the
    correct way to run this tool from the console?

Regards,
Gurce



On 25/10/12 09:14, Jeff Johnston wrote:

Hi Gurce,

The Linux Tools sources are in git so you can view them via the web or
clone them locally.

See our wiki: http://wiki.eclipse.org/Linux_Tools_Project/Git

-- Jeff J.


On 10/24/2012 06:06 PM, Gurce Isikyildiz wrote:

Hi Alex,

Thanks for the details. I'm reading the page you suggested. Being a
newbie at this, a lot is un-familiar to me. Could you help out on these 
points:

 > Libhover exension: ... Let's examine an example which specifies
libhover help for the glibc C Library:

I wasn't sure how to track down the xml mentioned here initially, I
managed to find it by:
- Browsing to my "eclipse/plugins" sub-folder
- Unzipping the
"org.eclipse.linuxtools.cdt.libhover.glibc_1.1.0.201202152032.jar" file 
- Opening the "plugin.xml" within it in a text editor
Am I going about this the right way? Or is there some nicer/easier way 
to browse Eclipse plug-in files/details within the IDE itself?





 > C Library Data: The simplest form of Libhover data is for C
functions. Looking at org.eclipse.linuxtools.cdt.libhover.FunctionInfo: 

How do I browse to the code you mention for FunctionInfo. I tried the
following:
- Unzipped "org.eclipse.linuxtools.cdt.libhover_1.2.0.201209191645.jar" 
- Browsed to the "org/eclipse/linuxtools/cdt/libhover/" sub-folder
- Tried opening "FunctionInfo.class" in Eclipse, but I just see an error 
in the editor saying:
Could not open the editor: The Class File Viewer cannot handle the given 
input ('org.eclipse.ui.ide.FileStoreEditorInput').

I googled this online, someone mentioned eclipse can only view .class
files if they are part of the current workspace/project. Oh, so should I unzip this jar and import it into an Eclipse workspace as a new project? 

Regards,
Gurce


On 24/10/12 17:36, akurtakov wrote:

Hi,
Comments inline.


On Wed, Oct 24, 2012 at 8:46 AM, Gurce Isikyildiz
<GIsikyildiz@xxxxxxxx> wrote:

Hiya all,

I'm using Eclipse in our Linux work environment. I was pondering
options to
add OpenGL / SDL documentation inline within the Eclipse environment.
The closest possibility I saw was the libhover project. Would you say 
that's
the right direction I should be looking at?

Absolutely.

Anyone have any pointers on where to start this journey? What to
ponder? How
to get more familiar with libhover?

You would better start with
http://wiki.eclipse.org/Linux_Tools_Project/Libhover/Developers_Guide 
. If SDL use some well known format for the documentation you might
have easier task e.g. libhover has built in support for gtk-doc
generated one. Let us know if you have any question and consider
contributing back so others can use the SDL docs easily too.

Regards,
Alex


Regards,
Gurce


Gurce Isikyildiz | Software Engineer (Australasia) | SHFL
entertainment | P:
+61 2 8707 6617 | F: +61 2 9773 0828
Effective from 1 October 2012, Shuffle Master Australasia Pty Limited 
has
changed its name to SHFL entertainment (Australasia) Pty Limited.
Please consider the environment before printing this e-mail
Internet Confidentiality Statement

This message is intended for the sole use of the individual and
entity to
whom
it is addressed, and may contain information that is privileged,
confidential and exempt from disclosure under applicable law. If you 
are not
the intended addressee, nor authorized to receive for the intended
addressee, you are hereby
notified that you may not use, copy, disclose or distribute to anyone 
the
message or any information contained in the message. If you have
received
this message in error, please immediately advise the sender by reply 
email
and delete the message. Thank you.
Gurce Isikyildiz | Software Engineer (Australasia) | SHFL entertainment 
| P: +61 2 8707 6617 | F: +61 2 9773 0828

Effective from 1 October 2012, Shuffle Master Australasia Pty Limited
has changed its name to SHFL entertainment (Australasia) Pty Limited.
Please consider the environment before printing this e-mail


Gurce Isikyildiz | Software Engineer (Australasia) | SHFL
entertainment | P: +61 2 8707 6617 | F: +61 2 9773 0828

*Effective from 1 October 2012, Shuffle Master Australasia Pty
Limited has changed its name to SHFL entertainment (Australasia) Pty
Limited.*

P Please consider the environment before printing this e-mail
Gurce Isikyildiz | Software Engineer (Australasia) | SHFL entertainment | P: +61 2 8707 6617 | F: +61 2 9773 0828
Effective from 1 October 2012, Shuffle Master Australasia Pty Limited has changed its name to SHFL entertainment (Australasia) Pty Limited. 
Please consider the environment before printing this e-mail



Gurce Isikyildiz | Software Engineer (Australasia) | SHFL entertainment | P: +61 2 8707 6617 | F: +61 2 9773 0828

Effective from 1 October 2012, Shuffle Master Australasia Pty Limited has changed its name to SHFL entertainment (Australasia) Pty Limited.
Please consider the environment before printing this e-mail
_______________________________________________

linuxtools-dev mailing list
linuxtools-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/linuxtools-dev

_______________________________________________
linuxtools-dev mailing list
linuxtools-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/linuxtools-dev


Internet Confidentiality Statement
This message is intended for the sole use of the individual and entity 
to whom
it is addressed, and may contain information that is privileged,
confidential and exempt from disclosure under applicable law. If you are not the intended addressee, nor authorized to receive for the intended 
addressee, you are hereby
notified that you may not use, copy, disclose or distribute to anyone
the message or any information contained in the message. If you have
received this message in error, please immediately advise the sender by 
reply email and delete the message. Thank you.

_______________________________________________
linuxtools-dev mailing list
linuxtools-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/linuxtools-dev


_______________________________________________
linuxtools-dev mailing list
linuxtools-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/linuxtools-dev


Internet Confidentiality Statement
This message is intended for the sole use of the individual and entity to whom it is addressed, and may contain information that is privileged, confidential and exempt from disclosure under applicable law. If you are not the intended addressee, nor authorized to receive for the intended addressee, you are hereby notified that you may not use, copy, disclose or distribute to anyone the message or any information contained in the message. If you have received this message in error, please immediately advise the sender by reply email and 
delete the message.
Thank you.



_______________________________________________
linuxtools-dev mailing list
linuxtools-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/linuxtools-dev





_______________________________________________
linuxtools-dev mailing list
linuxtools-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/linuxtools-dev


Internet Confidentiality Statement
This message is intended for the sole use of the individual and entity to whom it is addressed, and may contain information that is privileged, confidential and exempt from disclosure under applicable law. If you are not the intended addressee, nor authorized to receive for the intended addressee, you are hereby notified that you may not use, copy, disclose or distribute to anyone the message or any information contained in the message. If you have received this message in error, please immediately advise the sender by reply email and delete the message. Thank you. 

_______________________________________________
linuxtools-dev mailing list
linuxtools-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/linuxtools-dev


Internet Confidentiality Statement

This message is intended for the sole use of the individual and entity to whom
it is addressed, and may contain information that is privileged, confidential and exempt from disclosure under applicable law. If you are not the intended addressee, nor authorized to receive for the intended addressee, you are hereby notified that you may not use, copy, disclose or distribute to anyone the message or any information contained in the message. If you have received this message in error, please immediately advise the sender by reply email and delete the message. Thank you.

Back to the top