RTT website showing incorrect header files

v1.8.x API reference gives


A TaskContext exports the commands, methods, events, properties and ports a task has. More...
#include

Inheritance diagram for TaskContext:

Shouldn't this be ... ?


#include

Did not check OCL, etc.

RTT website showing incorrect header files

On Tue, Jun 23, 2009 at 02:50, <kiwi [dot] net [..] ...> wrote:
> v1.8.x API reference gives
>
> &#10;&gt; A TaskContext exports the commands, methods, events, properties and ports a task has. More...&#10;&gt;  #include &lt;/home/kaltan/src/www/orocos-1.0/export/build/orocos-rtt-1.8.4/src/TaskContext.hpp&gt;&#10;&gt;&#10;&gt; Inheritance diagram for TaskContext:&#10;&gt;
>
> Shouldn't this be ... ?
>
> &#10;&gt;  #include &lt;rtt/TaskContext.hpp&gt;&#10;&gt;

Oh great. They worked around my symlink trick. The resolved the
symlink to the real path and then the stripping magic did not work
anymore. AFAIKT, with our directory structure, you can only have in
the docs:
&#10; #include &lt;TaskContext.hpp&gt;&#10;
or
&#10;  #include &lt;src/TaskContext.hpp&gt;&#10;

Both are wrong (so I made a symlink to src which was called 'rtt',
which fixed this for older Doxygen versions).

Don't we all hate Doxygen ?

Peter

RTT website showing incorrect header files

On Tue, Jun 23, 2009 at 10:59 AM, Peter Soetens <peter [..] ...>wrote:

> On Tue, Jun 23, 2009 at 02:50, <kiwi [dot] net [..] ...> wrote:
> > v1.8.x API reference gives
> >
> > &#10;&gt; &gt; A TaskContext exports the commands, methods, events, properties and ports&#10;&gt; a task has. More...&#10;&gt; &gt;  #include&#10;&gt; &lt;/home/kaltan/src/www/orocos-1.0/export/build/orocos-rtt-1.8.4/src/TaskContext.hpp&gt;&#10;&gt; &gt;&#10;&gt; &gt; Inheritance diagram for TaskContext:&#10;&gt; &gt;
> >
> > Shouldn't this be ... ?
> >
> > &#10;&gt; &gt;  #include &lt;rtt/TaskContext.hpp&gt;&#10;&gt; &gt;
>
> Oh great. They worked around my symlink trick. The resolved the
> symlink to the real path and then the stripping magic did not work
> anymore. AFAIKT, with our directory structure, you can only have in
> the docs:
> &#10;&gt;  #include &lt;TaskContext.hpp&gt;&#10;&gt;
> or
> &#10;&gt;  #include &lt;src/TaskContext.hpp&gt;&#10;&gt;
>
> Both are wrong (so I made a symlink to src which was called 'rtt',
> which fixed this for older Doxygen versions).
>
> Don't we all hate Doxygen ?

What's the problem with Doxygen and file including again? I didn't quite
understand the issue here.
Is it about including files as #include <TaskContext.hpp> and not as
#include <src/TaskContext.hpp>?, about not showing the src folder in the
generated doc? :-/

>
>
> Peter
> --
> Orocos-Dev mailing list
> Orocos-Dev [..] ...
> http://lists.mech.kuleuven.be/mailman/listinfo/orocos-dev
>

RTT website showing incorrect header files

2009/6/23 Adolfo Rodríguez Tsouroukdissian <adolfo [dot] rodriguez [..] ...>:
>
>
> On Tue, Jun 23, 2009 at 10:59 AM, Peter Soetens <peter [..] ...>
> wrote:
>>
>> On Tue, Jun 23, 2009 at 02:50, <kiwi [dot] net [..] ...> wrote:
>> > v1.8.x API reference gives
>> >
>> > &#10;&gt;&gt; &gt; A TaskContext exports the commands, methods, events, properties and&#10;&gt;&gt; &gt; ports a task has. More...&#10;&gt;&gt; &gt;  #include&#10;&gt;&gt; &gt; &lt;/home/kaltan/src/www/orocos-1.0/export/build/orocos-rtt-1.8.4/src/TaskContext.hpp&gt;&#10;&gt;&gt; &gt;&#10;&gt;&gt; &gt; Inheritance diagram for TaskContext:&#10;&gt;&gt; &gt;
>> >
>> > Shouldn't this be ... ?
>> >
>> > &#10;&gt;&gt; &gt;  #include &lt;rtt/TaskContext.hpp&gt;&#10;&gt;&gt; &gt;
>>
>> Oh great. They worked around my symlink trick. The resolved the
>> symlink to the real path and then the stripping magic did not work
>> anymore. AFAIKT, with our directory structure, you can only have in
>> the docs:
>> &#10;&gt;&gt;  #include &lt;TaskContext.hpp&gt;&#10;&gt;&gt;
>> or
>> &#10;&gt;&gt;  #include &lt;src/TaskContext.hpp&gt;&#10;&gt;&gt;
>>
>> Both are wrong (so I made a symlink to src which was called 'rtt',
>> which fixed this for older Doxygen versions).
>>
>> Don't we all hate Doxygen ?
>
> What's the problem with Doxygen and file including again? I didn't quite
> understand the issue here.
> Is it about including files as #include <TaskContext.hpp> and not as
> #include <src/TaskContext.hpp>?, about not showing the src folder in the
> generated doc? :-/

As Stephen suggested, the doc page should say
#include<rtt/TaskContext.hpp>. With the current RTT directory
structure, this is impossible, unless you start copying/installing all
headers in a rtt/ directory. But this would/might require a build, but
I'd rather have Doxygen to work also without first building/installing
RTT.

Peter

RTT website showing incorrect header files

On Jun 23, 2009, at 05:51 , Peter Soetens wrote:

> 2009/6/23 Adolfo Rodríguez Tsouroukdissian <adolfo [dot] rodriguez [..] ...
> >:
>>
>>
>> On Tue, Jun 23, 2009 at 10:59 AM, Peter Soetens <peter [..] ...
>> >
>> wrote:
>>>
>>> On Tue, Jun 23, 2009 at 02:50, <kiwi [dot] net [..] ...> wrote:
>>>> v1.8.x API reference gives
>>>>
>>>> &#10;&gt;&gt;&gt;&gt; A TaskContext exports the commands, methods, events, properties and&#10;&gt;&gt;&gt;&gt; ports a task has. More...&#10;&gt;&gt;&gt;&gt;  #include&#10;&gt;&gt;&gt;&gt; &lt;/home/kaltan/src/www/orocos-1.0/export/build/orocos-rtt-1.8.4/ &#10;&gt;&gt;&gt;&gt; src/TaskContext.hpp&gt;&#10;&gt;&gt;&gt;&gt;&#10;&gt;&gt;&gt;&gt; Inheritance diagram for TaskContext:&#10;&gt;&gt;&gt;&gt;
>>>>
>>>> Shouldn't this be ... ?
>>>>
>>>> &#10;&gt;&gt;&gt;&gt;  #include &lt;rtt/TaskContext.hpp&gt;&#10;&gt;&gt;&gt;&gt;
>>>
>>> Oh great. They worked around my symlink trick. The resolved the
>>> symlink to the real path and then the stripping magic did not work
>>> anymore. AFAIKT, with our directory structure, you can only have in
>>> the docs:
>>> &#10;&gt;&gt;&gt;  #include &lt;TaskContext.hpp&gt;&#10;&gt;&gt;&gt;
>>> or
>>> &#10;&gt;&gt;&gt;  #include &lt;src/TaskContext.hpp&gt;&#10;&gt;&gt;&gt;
>>>
>>> Both are wrong (so I made a symlink to src which was called 'rtt',
>>> which fixed this for older Doxygen versions).
>>>
>>> Don't we all hate Doxygen ?
>>
>> What's the problem with Doxygen and file including again? I didn't
>> quite
>> understand the issue here.
>> Is it about including files as #include <TaskContext.hpp> and not as
>> #include <src/TaskContext.hpp>?, about not showing the src folder
>> in the
>> generated doc? :-/
>
> As Stephen suggested, the doc page should say
> #include<rtt/TaskContext.hpp>. With the current RTT directory
> structure, this is impossible, unless you start copying/installing all
> headers in a rtt/ directory. But this would/might require a build, but
> I'd rather have Doxygen to work also without first building/installing
> RTT.

#5?

http://www.stack.nl/~dimitri/doxygen/faq.html

RTT website showing incorrect header files

v1.8.x API reference gives

&#10;A TaskContext exports the commands, methods, events, properties and ports a task has. More...&#10; #include &lt;/home/kaltan/src/www/orocos-1.0/export/build/orocos-rtt-1.8.4/src/TaskContext.hpp&gt;&#10;&#10;Inheritance diagram for TaskContext:&#10;

Shouldn't this be ... ?

&#10; #include &lt;rtt/TaskContext.hpp&gt;&#10;

Did not check OCL, etc.