ffpriv_consonant_gradation.h

Go to the documentation of this file.

/*
 * finflect - Algorithms and tools for inflecting Finnish nouns
 * Copyright (C) 2004, 2005  The FinFlect Team
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * 
 * For the complete legal text of the GNU Lesser General Public License,
 * see the file LICENSE. For a complete list of authors and copyright
 * holders, see the file AUTHORS.
 */

/**
 * @file ffpriv_consonant_gradation.h Defines the consonant gradation function that's
 * implemented in ffpriv_consonant_gradation.c.
 */

#ifndef __FFPRIV_CONSONANT_GRADATION_H
#define __FFPRIV_CONSONANT_GRADATION_H

#ifdef __cplusplus
extern "C" {
#endif

#include "fftypes.h"
#include "ffstring.h"

/**
 * Applies consonant gradation on the given word.
 * @param word The word to gradate
 * @param direction The gradation direction (todo: what does this mean?)
 * @param type The gradation type (todo: what does this mean?)
 * @return 0 on success, -1 on error.
 * @todo Complete this documentation
 */
ffint32 ffpriv_consonant_gradation(ffstring* word, ffuint32 direction, ffuint32 type);

#ifdef __cplusplus
}
#endif
#endif

---