could someone please explain what I am doing wrong when documenting my typedef NS_ENUM?
This is my syntax:
/** The different menu items
*/
typedef NS_ENUM(NSInteger, kMenuItem) {
/** The start page */
kMenuItemStartPage = 0,
/** The new round item */
kMenuItemNewRound,
/** The archive item */
kMenuItemArchive,
/** The participants item */
kMenuItemMyParticipants,
/** The locations item */
kMenuItemMyLocations,
/** The settings */
kMenuItemSettings,
/** The contact page */
kMenuItemContact,
/** The count */
kMenuItemTotal
};
/**
* This is the Menu View Controller.
*
* The menu view controller handles the menu the menu and its options. You can access the menu view controller using the `menuContainer` in the `ApplicationDelegate`
*
*/
@interface MenuTVC : UITableViewController
@end
My run script build phase:
APPLEDOC_PATH=`which appledoc`
if [ $APPLEDOC_PATH ]; then
echo "Generating docs!";
$APPLEDOC_PATH \
--project-name "${PRODUCT_NAME}" \
--project-company "Sogeti Sverige AB" \
--company-id "se.domain.project" \
--output "Docs" \
--no-install-docset \
--exit-threshold "2" \
--keep-undocumented-objects \
--keep-undocumented-members \
--keep-intermediate-files \
--ignore "Pods" \
--ignore ".m" \
--index-desc "${PROJECT_DIR}/Readme.md" \
${PROJECT_DIR}/Prevent
else
echo "AppleDoc not found or installed!"
fi;
The result:
And build result:
From the terminal:
$ which appledoc
/usr/bin/appledoc
$ appledoc --version
appledoc version: 2.2 (build 963)
I just can't seem to figure it out.
Thanks in advance!
I just figured out that the enums are documented in the index.html
file, and not the class documentation itself.
It does work.