[Check]: Disable the document to correct build error.
[platform/upstream/check.git] / src / check_str.h
1 /*
2  * Check: a unit test framework for C
3  * Copyright (C) 2001, 2002 Arien Malec
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
18  * MA 02110-1301, USA.
19  */
20
21 #ifndef CHECK_STR_H
22 #define CHECK_STR_H
23
24 /* Return a string representation of the given TestResult.  Return
25    value has been malloc'd, and must be freed by the caller */
26 char *tr_str(TestResult * tr);
27
28 /* Return a string representation of the given TestResult message
29    without the test id or result type. This is suitable for separate
30    formatting of the test and the message. Return value has been 
31    malloc'd, and must be freed by the caller */
32 char *tr_short_str(TestResult * tr);
33
34 /* Return a string representation of the given SRunner's run
35    statistics (% passed, num run, passed, errors, failures). Return
36    value has been malloc'd, and must be freed by the caller
37 */
38 char *sr_stat_str(SRunner * sr);
39
40 char *ck_strdup_printf(const char *fmt, ...);
41
42 #endif /* CHECK_STR_H */