//
//  OCHamcrest - HCSelfDescribing.h
//  Copyright 2013 hamcrest.org. See LICENSE.txt
//
//  Created by: Jon Reid, http://qualitycoding.org/
//  Docs: http://hamcrest.github.com/OCHamcrest/
//  Source: https://github.com/hamcrest/OCHamcrest
//

#import <Foundation/Foundation.h>

#import "HCDescription.h"


/**
    The ability of an object to describe itself.

    @ingroup core
 */
@protocol HCSelfDescribing <NSObject>

/**
    Generates a description of the object.
    
    The description may be part of a description of a larger object of which this is just a
    component, so it should be worded appropriately.
    
    @param description  The description to be built or appended to.
 */
- (void)describeTo:(id<HCDescription>)description;

@end