FieldContainer documentation from .fcd file doesn't get into the generated code

The version of fcdProces in trunk, seems to do "The Right Thing", but note that normally for Foo.fcd only FooBase.{h,cpp,inl} and FooFields.h are generated to avoid overwriting user code in the none-Base files.

If nobody objects I'll close this ticket by the end of the week - 2006/12/01.

Just a quick comment: my idea was to move the documentation out of the Foo.cpp file and into the FooBase.cpp file. doxygen allows you to document anything anywhere, so documenting Foo in FooBase.cpp is not a problem. We will have to remove the docs from the existing source files, but for testing doing that in just one should be fine.

Replying to dirk:

Just a quick comment: my idea was to move the documentation out of the Foo.cpp file and into the FooBase.cpp file. doxygen allows you to document anything anywhere, so documenting Foo in FooBase.cpp is not a problem. We will have to remove the docs from the existing source files, but for testing doing that in just one should be fine.

Ok. Is it possible to document a class in multiple places, i.e. can I do:

In FooBase.cpp:

/*! \class Foo <doc from the .fcd file>

 */

and in Foo.cpp:

/*! \class Foo <doc about the user code in Foo>

 */

and get the concatenation of both ?

If not and since the non-base files will have to be touched anyways I would prefer to keep the doc in Foo.cpp to allow extensions of it.

Replying to cneumann:

Ok. Is it possible to document a class in multiple places, i.e. can I do:

…

and get the concatenation of both ?

If not and since the non-base files will have to be touched anyways I would prefer to keep the doc in Foo.cpp to allow extensions of it.

For changing the docs you would have to change the .fcd and regenerate the Base. The disadvantage is having the docs in a separate file (but there is a lot of information in that one anyway), the advantage is that the docs can be made available to the runtime, if needed.

Replying to dirk:

Replying to cneumann:

Ok. Is it possible to document a class in multiple places, i.e. can I do:

…

and get the concatenation of both ?

If not and since the non-base files will have to be touched anyways I would prefer to keep the doc in Foo.cpp to allow extensions of it.

For changing the docs you would have to change the .fcd and regenerate the Base. The disadvantage is having the docs in a separate file (but there is a lot of information in that one anyway), the advantage is that the docs can be made available to the runtime, if needed.

Ah ok, I agree this is best, since it keeps the doc in on place (the .fcd).

I'll work on this, unless you'd like to do it yourself, of course

completed with r439