Re: [linuxtools-dev] Where is libstdc++ documentation. Must I generate it?
2011/6/20 Jeff Johnston : > On 06/18/2011 05:33 AM, Germán Diago wrote: >> >> Hello. I'm trying the latest development release of eclipse linuxtools and >> cdt. >> I cannot figure out how to install the libstdc++ documentation. >> In the documentation areas I can select devhelp documentation and glibc >> documentation. >> >> I would like to: >> >> 1.- have hovers for libstdc++, >> and, if possible, >> > > These are shipped in Fedora's eclipse-cdt package, but cannot be shipped via > the Eclipse update site. The problem is that the libstdc++ documentation > has been licensed GPL. This is due to doxygen comments being taken from the > code which is GPL. In our minds, comments are simply that: comments, and > this work should be licensed under the GFDL, but RMS (Richard Stallman) has > rejected this. The maintainers of gcc/libstdc++ agree with us, but that > doesn't change things. > > GPL licensed code cannot be hosted at Eclipse.org. > >> 2.- to configure the documentation for libgtkmm (which has devhelp >> support). >> >> and, as an extra, but I don't mind too much >> > > We currently don't have support for C++ devhelp libraries, but there is an > open enhancment request to add this and we hope to work on this in the near > future. > >> 3.- Generate documentation for my own libraries (which is written in >> doxygen) >> >> I looked at the >> documentation included in the help contents but I cannot figure out how to >> do it and I can't find the tools to generate the documentation .libhover >> file. >> Besides that, I don't know if I must edit an xml or something else >> additionally. >> > > The documentation documents the class DoxygenCPPInfo which is found in the > org.eclipse.linuxtools.cdt.libhover.libstdcxx source code which you will > have to download from the LinuxTools git repository (it is not provided from > the update sites due to the licensing issue above): > > git://git.eclipse.org/gitroot/linuxtools/org.eclipse.linuxtools.git > > checkout libhover/org.eclipse.linuxtools.cddt.libhover.libstdcxx into your > workspace. > > DoxygenCPPInfo isn't particularly elegant and is specialized to handle > libstdc++, but might work for your purposes. > >> Could you instruct me on how to do it? If there is somewhere else where to >> install libstdc++ documentation from, it would be ideal. > > How to do it would be to try the DoxygenCPPInfo application, passing in your > file as input and specifying the output file (see main method). > > If it doesn't work, then you will need to debug to see what > additions/changes would be required. > > Regarding elsewhere to install libstdc++ documentation from: > > You could always download the source for > libhover/org.eclipse.linuxtools.cdt.libhover.libstdcxx and then right-click > and Export->Plug-in Development->Deployable Plug-ins and Features > > Choose a directory to place the result and then do an > > Import->Plug-in Development->Plug-ins and Fragments > > Specify the same directory and you can import the plug-in. Note that the > libstdcxx plugin by default loads the data from sourceware.org via a URL. > You should only have to do this once per workspace as the default is to > cache libhover data. > > Regards, > > -- Jeff J. > > ___ > linuxtools-dev mailing list > linuxtools-dev@eclipse.org > https://dev.eclipse.org/mailman/listinfo/linuxtools-dev > Thanks for all your help. It's a little sad that libstdc++ comments cannot be shipped :-(. But anyway, I'll try my best to get them. ___ linuxtools-dev mailing list linuxtools-dev@eclipse.org https://dev.eclipse.org/mailman/listinfo/linuxtools-dev
[linuxtools-dev] Where is libstdc++ documentation. Must I generate it?
Hello. I'm trying the latest development release of eclipse linuxtools and cdt. I cannot figure out how to install the libstdc++ documentation. In the documentation areas I can select devhelp documentation and glibc documentation. I would like to: 1.- have hovers for libstdc++, and, if possible, 2.- to configure the documentation for libgtkmm (which has devhelp support). and, as an extra, but I don't mind too much 3.- Generate documentation for my own libraries (which is written in doxygen) I looked at the documentation included in the help contents but I cannot figure out how to do it and I can't find the tools to generate the documentation .libhover file. Besides that, I don't know if I must edit an xml or something else additionally. Could you instruct me on how to do it? If there is somewhere else where to install libstdc++ documentation from, it would be ideal. ___ linuxtools-dev mailing list linuxtools-dev@eclipse.org https://dev.eclipse.org/mailman/listinfo/linuxtools-dev
Re: [linuxtools-dev] Parsing c++ doxygen comments.
> While the libstdc++ libhover support is based upon doxygen comments in the > libstdc++ code, this is done far in advance. A parser is run on the > libstdc++ doxygen documentation output to create a binary which is just a > serialized version of the libhover Java classes that make look-up quick. > The parser that creates this binary is provided as part of the source code > for the linux tools libstdc++ libhover plug-in. It particularly elegantly > written since it is meant to be run as a utility and not during the Eclipse > session. Can I execute this parser from within eclipse at any time? It would be very useful. Or at least it would be useful to know how to execute it, cause I can't find it. > With regards to dynamic libhover doxygen support, there isn't anything in > the works. > > Briefly thinking about it, I believe this would be best handled by the CDT > parser which is parsing the source and populating the CDT model. It would > be relatively easy for them to interpret doxygen comments during this > process and thus make it very quick to access them when needed. It is too > late to get this into the Indigo release which will be shortly released. I > would recommend opening an RFE against the CDT parser or editor components. I'll open a bug for that in the eclipse editor component. ___ linuxtools-dev mailing list linuxtools-dev@eclipse.org https://dev.eclipse.org/mailman/listinfo/linuxtools-dev
Re: [linuxtools-dev] Parsing c++ doxygen comments.
Thank you. It also helped. But what I mean by parser is a tool that parses doxygen comments and makes the function information available as it is done with libhover for C in linuxtools. What is the status of that feature? Thanks in advance. 2011/4/30 Alexander Kurtakov : > On 05:35:35 PM Saturday, April 30, 2011 Germán Diago wrote: >> Hello. >> >> I've been using eclipse linuxtools for a while and I think that you're >> all doing a great work >> with valgrind, oprofile, etc. >> >> I would like to ask you when c++ doxygen comments parsing will be >> available. It's a feature >> that I'm missing a lot since in java, documentation comments are very >> helpful. > Have you tried the internal cdt doxygen support? > Window/Preferences/C&C++/Editor page in the bottom there is Documentation tool > support and a drop down with None and Doxygen. Selecting doxygen should > highlight and even autocomplete doxygen tags. > > Regards, > Alex > > >> >> Thanks in advance. >> ___ >> linuxtools-dev mailing list >> linuxtools-dev@eclipse.org >> https://dev.eclipse.org/mailman/listinfo/linuxtools-dev > ___ > linuxtools-dev mailing list > linuxtools-dev@eclipse.org > https://dev.eclipse.org/mailman/listinfo/linuxtools-dev > ___ linuxtools-dev mailing list linuxtools-dev@eclipse.org https://dev.eclipse.org/mailman/listinfo/linuxtools-dev
[linuxtools-dev] Parsing c++ doxygen comments.
Hello. I've been using eclipse linuxtools for a while and I think that you're all doing a great work with valgrind, oprofile, etc. I would like to ask you when c++ doxygen comments parsing will be available. It's a feature that I'm missing a lot since in java, documentation comments are very helpful. Thanks in advance. ___ linuxtools-dev mailing list linuxtools-dev@eclipse.org https://dev.eclipse.org/mailman/listinfo/linuxtools-dev
