x

Search in
Sort by:

Question Status:

Search help

  • Simple searches use one or more words. Separate the words with spaces (cat dog) to search cat,dog or both. Separate the words with plus signs (cat +dog) to search for items that may contain cat but must contain dog.
  • You can further refine your search on the search results page, where you can search by keywords, author, topic. These can be combined with each other. Examples
    • cat dog --matches anything with cat,dog or both
    • cat +dog --searches for cat +dog where dog is a mandatory term
    • cat -dog -- searches for cat excluding any result containing dog
    • [cats] —will restrict your search to results with topic named "cats"
    • [cats] [dogs] —will restrict your search to results with both topics, "cats", and "dogs"

What tool does Epic use for generating API documentation?

I would like to make my own documentation and follow similar conventions as the engine.

Product Version: Not Selected
Tags:
more ▼

asked Jul 31 '14 at 07:17 PM in C++ Programming

avatar image

dzeligman
713 32 30 56

(comments are locked)
10|2000 characters needed characters left
Viewable by all users

2 answers: sort voted first

We use a combination of Doxygen (a customized version to handle UE4's unique features) to generate XML and a completely custom tool (APIDocTool) to parse that into the format our documentation is stored in. Then we have another tool (UnrealDocTool) that publishes all of our documentation to HTML.

We would love to make all of the tools available if possible (and some of them may already be thorugh GitHub), but the customized Doxygen binaries may be an issue with redistribution. We would have to check with our legal department on that one.

more ▼

answered Jul 31 '14 at 07:22 PM

avatar image

Jeff Wilson ♦♦ STAFF
458 7 5 17

avatar image dzeligman Jul 31 '14 at 07:32 PM

Thanks for the answer.

avatar image waneck Sep 10 '15 at 06:08 PM

@Jeff Wilson, any news on the modified Doxygen sources release? Thank you!

avatar image BrianMilligan Apr 26 '16 at 04:24 PM

I'd really like to use the Doxygen tool as well

avatar image Lightwish. Sep 06 '17 at 07:56 PM

Any news on this yet? It would be really great if we could tweak the documentation to our needs or translate it into other languages, as mentioned in this post.

(comments are locked)
10|2000 characters needed characters left
Viewable by all users

I really should do a better searching job before posting on here.

The tool is located in Engine\Source\Programs\UnrealDocTool.

more ▼

answered Jul 31 '14 at 07:19 PM

avatar image

dzeligman
713 32 30 56

avatar image Todd.Vance Dec 11 '17 at 11:12 PM

The tool is located in Engine\Source\Programs\UnrealDocTool.

Apparently not anymore, as of 4.18.2 or perhaps earlier.

(comments are locked)
10|2000 characters needed characters left
Viewable by all users
Your answer
toggle preview:

Up to 5 attachments (including images) can be used with a maximum of 5.2 MB each and 5.2 MB total.

Follow this question

Once you sign in you will be able to subscribe for any updates here

Answers to this question