In memory of Ben “bushing” Byer, who passed away on Monday, February 8th, 2016.

Difference between revisions of "User:CarstenK/libogc and XCode"

From WiiBrew
Jump to navigation Jump to search
(generating an XCode 3 (Leopard) docset for libogc)
 
m (typos)
 
Line 16: Line 16:
 
  PROJECT_NUMBER        = "libogc 20080602"
 
  PROJECT_NUMBER        = "libogc 20080602"
 
  OUTPUT_DIRECTORY      = /Users/$USER/Desktop/Wii/doxygen/
 
  OUTPUT_DIRECTORY      = /Users/$USER/Desktop/Wii/doxygen/
  DOCSET_FEEDNAME        = "libogc"
+
  DOCSET_FEEDNAME        = "libOGC"
  DOCSET_BUNDLE_ID      = org.devkitpro.libogc
+
  DOCSET_BUNDLE_ID      = org.devkitPro.libOGC
  
 
Important:
 
Important:
Line 25: Line 25:
 
; to activate without restarting XCode<nowiki>:</nowiki>: <code>osascript -e "tell app \"XCode\" to load documentation set with path \"/Users/$USER/Library/Developer/Shared/Documentation/DocSets/\""</code>
 
; to activate without restarting XCode<nowiki>:</nowiki>: <code>osascript -e "tell app \"XCode\" to load documentation set with path \"/Users/$USER/Library/Developer/Shared/Documentation/DocSets/\""</code>
  
I couldn't get the '''Research Assistant''' to show any contextual information yet but the API & Documentation search works just fine, doxygen even generates some nice images.
+
I can't get the '''Research Assistant''' to show any contextual information yet but the API & Documentation search works just fine, doxygen even generates some nice images.

Latest revision as of 05:02, 8 September 2008

If you don’t know what doxygen is, you probably don't need it... (just yet).

An XCode 3 (Leopard) docset for libogc can be generated with Doxygen-1.5.6.dmg.

The Apple instructions are a good place to start but here is some specific help below.

Doxygen.app GUI settings:

  • Working directory: /opt/devkitpro/libogc/include
  • GENERATE_DOCSET [X]
  • GENERATE_LATEX [ ] Whatever... You know what you doing.

Expert HTML output settings:

PROJECT_NUMBER         = "libogc 20080602"
OUTPUT_DIRECTORY       = /Users/$USER/Desktop/Wii/doxygen/
DOCSET_FEEDNAME        = "libOGC"
DOCSET_BUNDLE_ID       = org.devkitPro.libOGC

Important:

  • Any OUTPUT_DIRECTORY is fine but ~ is not recognized.
  • cd /Users/$USER/Desktop/Wii/doxygen/html (or wherever)
  • make install
to activate without restarting XCode:
osascript -e "tell app \"XCode\" to load documentation set with path \"/Users/$USER/Library/Developer/Shared/Documentation/DocSets/\""

I can't get the Research Assistant to show any contextual information yet but the API & Documentation search works just fine, doxygen even generates some nice images.