All geek questions in one place

Creating Apple Docs Projects for XCODE

I am trying to create apple documents for one of my projects. I use the following commands to generate documents ...

headerdoc2html -o OutPutDirectory InputDirectory

I get the following message ...

 Processing /Users/Ankit/Documents/Projects/pos/trunk/TestProject/TestProject/Test.h Skipping. No HeaderDoc comments found. No default encoding. Guessing. If date formats are wrong, try specifying an appropriate value in the LANG environment variable.

Any help is appreciated.

+4
source share
3 answers

I had the same problem. I fixed it by changing everything

 /// Comments

and

 /** * Comments */

Comments on

 /*! * Comments */

And it worked out fine for me.

+4
source

The LANG environment variable is not set in any place that your Xcode can access. Perhaps because it was not installed in your build settings.

When executing the command below, all environment variables will be printed, LANG will not be among them.

 xcodebuild -project Path/To/Your.xcodeproj -target "YourTarget" -showBuildSettings

Environment variables are managed in your schemes in the "Environment Variables" table, but I was not lucky to change them there. What I eventually did (since my headerdoc2html call was in the build script in my build phase of my target documentation), add this line to the top of my bash script:

 export LANG=en_US.US-ASCII

After that, the message disappeared.


My general script, for the curious.

 export LANG=en_US.US-ASCII /Applications/Xcode.app/Contents/Developer/usr/bin/headerdoc2html -o ~/Development/Path/To/My/Documentation ~/Development/Path/To/My/Project/Headers /Applications/Xcode.app/Contents/Developer/usr/bin/gatherheaderdoc ~/Development/Path/To/My/Documentation

(Xcode version 4.6.3)

+3
source

You can also use the -j flag to enable javadoc syntax and not change any code in your documentation.

 headerdoc2html -j -o OutputDirectory InputDirectory
0
source

Source: https://habr.com/ru/post/1495299/

More articles:


All Articles