Skip to content

Commit

Permalink
updated README.txt with detailed instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
BlackBears committed Jan 17, 2011
1 parent 2857daa commit 1272655
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@

Xcode version [REDACTED] does not implement a built-in script menu.

This suite of scripts is intended to bridge that gap in functionality until it is implemented in Xcode version [REDACTED].
This suite of scripts is intended to bridge that gap in functionality until it is implemented in Xcode version [REDACTED]. Specifically, it allows users to document their source files using Doxygen.

INSTALLATION:
(1) Download the files from the repository.
(2) Move the file Class block - Doxygen to ~/Library/Scripts/Xcode
(3) Enable the Script menu by in AppleScript Editor -> Preferences
(4) Move the file Doxygen-class.pl to any location you desire.
(5) Edit Class block - Doxygen.scpt file to update the following line:
set shellScriptPath to "~/Development/Scripts/Doxygen-class.pl"

USAGE:
(1) Currently the scripts contain only an example to document the class declaration. More functionality is planned.
(2) Go to the header file you wish to document.
(3) Highlight the @interface line
(4) Select the Class block - Doxygen script from the script menu.
(5) Fill in the details in the documentation block.

0 comments on commit 1272655

Please sign in to comment.