topic Re: How to edit function module documentation? in Application Development and Automation Discussions

How to edit function module documentation?

peter_langner — Tue, 03 Sep 2013 10:03:55 GMT

Hi,

could someone please explain, how I can edit the documentation of my function module? If I click on the name of the function module no doc is show in the properties. I can only edit the description. The element info is empty too. Should it show/edit the documentation?

Thank you for you help in advance,

Peter

Versions: ABAP 7.31 and ADT 2.7

Re: How to edit function module documentation?

oliver_beie — Tue, 03 Sep 2013 10:21:55 GMT

Hi Peter,

In SE80 right click on the FM name, choose Other Functions->Documentation->Change

Hope to see you soon again,

Oliver

Re: How to edit function module documentation?

peter_langner — Tue, 03 Sep 2013 10:26:53 GMT

Hi Olli,

in SE80 no problem, but how to do it in Eclipse? Any idea?

Peter

Re: How to edit function module documentation?

oliver_beie — Tue, 03 Sep 2013 10:42:43 GMT

No, sorry, I didn't realize 'eclipse'

Re: How to edit function module documentation?

schneidermic0 — Tue, 03 Sep 2013 12:32:38 GMT

Hi Peter,

Unfortunately, you can't use Eclipse to provide documentation to function modules (except ABAP Doc which is available in 7.40). This means, you have to open the SAP GUI by using the context menu entry "Open with > SAP GUI" to add or change documentation to function modules.

Element info also doesn't consider the documentation written in SAP GUI, yet. We would like to add this, but I can't promise when this will be available. 😕

I hope this answers your question.

Best regards,

Michael

Re: How to edit function module documentation?

ThFiedler — Tue, 03 Sep 2013 12:35:23 GMT

Hi Peter,

currently there is no possibility to edit the classic documentation in a native eclipse editor directly. You have to use the dynpro-based SAP Script Editor. You can right-click in the editor of the function module to open the SAP GUI editor for function modules and navigate from their to the documentation editor. What we can provide is a short-cut in eclipse to directly navigate to the documentation editor. We do that already in report editor to navigate to text elements.

With AS ABAP 7.4 we invented a completly new way to document your source code artifacts in eclipse. The new way is called ABAP DOC (similar to Java DOC) and is a special kind of comment notation in ABAP to specifiy documentation. If this new way to document your function modules is interesting for you you can read some more details in this document from Michael Schneider:

http://scn.sap.com/docs/DOC-40872

Kind Regards,

Thomas

Re: How to edit function module documentation?

peter_langner — Tue, 03 Sep 2013 15:15:29 GMT

Hi Michael,

in my opinion it would be good to have a possibility to display a documentation which displays the already existing documentation and short cut to jump to the maintanance of the text.

Regards,

Peter

Re: How to edit function module documentation?

dilorenzo — Mon, 09 Sep 2013 10:06:03 GMT

Hi Thomas,

could you please tell me where I can find the navigation to text elements in the report editor you mentioned above?

I'm using ADT 2.13 and can't find it.

Best Regards,

Dominik

Re: How to edit function module documentation?

ThFiedler — Mon, 09 Sep 2013 10:32:24 GMT

Hi Dominik,

currently this option only works against an AS ABAP 7.4 system. But we are working on a downport to 7.31 release also.

Kind Regards,

Thomas.

Re: How to edit function module documentation?

dilorenzo — Mon, 09 Sep 2013 11:00:48 GMT

Hi Thomas,

thank you for your fast answer.

Now I can stop searching

Best Regards,

Dominik