comparison sub/subreader.c @ 32646:651299b70463

Use '@' Doxygen syntax in subreader module.
author cboesch
date Fri, 24 Dec 2010 23:15:49 +0000
parents 7b135236a44a
children 58cd752c58d8
comparison
equal deleted inserted replaced
32645:715c9997201e 32646:651299b70463
2369 free( subd ); 2369 free( subd );
2370 } 2370 }
2371 2371
2372 #define MAX_SUBLINE 512 2372 #define MAX_SUBLINE 512
2373 /** 2373 /**
2374 * \brief parse text and append it to subtitle in sub 2374 * @brief parse text and append it to subtitle in sub
2375 * \param sub subtitle struct to add text to 2375 * @param sub subtitle struct to add text to
2376 * \param txt text to parse 2376 * @param txt text to parse
2377 * \param len length of text in txt 2377 * @param len length of text in txt
2378 * \param endpts pts at which this subtitle text should be removed again 2378 * @param endpts pts at which this subtitle text should be removed again
2379 * \param strip_markup if strip markup is set (!= 0), markup tags like <b></b> are ignored 2379 * @param strip_markup if strip markup is set (!= 0), markup tags like <b></b> are ignored
2380 * 2380 *
2381 * <> and {} are interpreted as comment delimiters, "\n", "\N", '\n', '\r' 2381 * <> and {} are interpreted as comment delimiters, "\n", "\N", '\n', '\r'
2382 * and '\0' are interpreted as newlines, duplicate, leading and trailing 2382 * and '\0' are interpreted as newlines, duplicate, leading and trailing
2383 * newlines are ignored. 2383 * newlines are ignored.
2384 */ 2384 */
2450 #endif 2450 #endif
2451 } 2451 }
2452 2452
2453 #define MP_NOPTS_VALUE (-1LL<<63) 2453 #define MP_NOPTS_VALUE (-1LL<<63)
2454 /** 2454 /**
2455 * \brief remove outdated subtitle lines. 2455 * @brief remove outdated subtitle lines.
2456 * \param sub subtitle struct to modify 2456 * @param sub subtitle struct to modify
2457 * \param pts current pts. All lines with endpts <= this will be removed. 2457 * @param pts current pts. All lines with endpts <= this will be removed.
2458 * Use MP_NOPTS_VALUE to remove all lines 2458 * Use MP_NOPTS_VALUE to remove all lines
2459 * \return 1 if sub was modified, 0 otherwise. 2459 * @return 1 if sub was modified, 0 otherwise.
2460 */ 2460 */
2461 int sub_clear_text(subtitle *sub, double pts) { 2461 int sub_clear_text(subtitle *sub, double pts) {
2462 int i = 0; 2462 int i = 0;
2463 int changed = 0; 2463 int changed = 0;
2464 while (i < sub->lines) { 2464 while (i < sub->lines) {