Objective-C/iOS method document format

Post date: Jan 29, 2014 6:10:59 AM

This is Apple Inc recommended format to give your comments about your custom methods.

For class declaration:

    File: CAUITransportView.h

 Abstract: 

  Version: 1.1.1

 Disclaimer: IMPORTANT:  This is bla bla bla

#import <UIKit/UIKit.h>

#import "CAUITransportButton.h"

//! request a network connection for a web service call : NSObject

/*! call the web service for the login.

 @author Created by Boobalan Munusamy

 @date 08/04/2014.

 @copyright Copyright 2011 GreatIndiaClub. All rights reserved.

 @details VWMobile

 @see LoginViewController

 @see ProcessViewController

 */

@protocol CAUITransportEngine;

For Method declaration:

/*!

 @function       getEmployeeDetails

 @abstract       getEmployeeDetails

 @discussion     This function will fetch employee details based on employee id

 @param          strEmpId 

employee unique id

 @result         an Array of Employee

 */

-(NSArray*)getEmployeeDetails:(NSString *)strEmpId{

}