Bug 16271 - FcResult not documented
Summary: FcResult not documented
Status: RESOLVED MOVED
Alias: None
Product: fontconfig
Classification: Unclassified
Component: doc (show other bugs)
Version: 2.4
Hardware: Other All
: medium normal
Assignee: fontconfig-bugs
QA Contact: Behdad Esfahbod
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-06-08 08:18 UTC by Behdad Esfahbod
Modified: 2018-08-20 21:51 UTC (History)
3 users (show)

See Also:
i915 platform:
i915 features:


Attachments

Description Behdad Esfahbod 2008-06-08 08:18:49 UTC
Reading man page for FcPatternGet, I see it returns FcResult.  But no man page for that type.  Also, FcPatternGet man page doesn't have the section about return value.  Same about some other man pages.  Notably, FcPatternGet-Types.
Comment 1 Behdad Esfahbod 2008-08-12 14:53:47 UTC
Umm, I don't know the docs system enough to fix this one, but would be nice to fix for 2.7.
Comment 2 Behdad Esfahbod 2009-01-07 16:00:24 UTC
Same about FcMatchKind
Comment 3 Stephen C. North 2009-02-18 15:08:52 UTC
Please is it possible to get the "quality" of the match, so we can report near-total match failures to a human when necessary?


Comment 4 Akira TAGOH 2012-03-12 22:59:07 UTC
Hmm, I don't see any particular section for the return value in any manpages at all. but some manpages explicitly has the doc for the return value and appears at the description.

If we want to have the return value section, we need to update func.sgml template and docs in .fncs as well.

(In reply to comment #3)
> Please is it possible to get the "quality" of the match, so we can report
> near-total match failures to a human when necessary?

Any patches for suggestion are welcome!
Comment 5 Behdad Esfahbod 2012-03-13 07:49:19 UTC
(In reply to comment #3)
> Please is it possible to get the "quality" of the match, so we can report
> near-total match failures to a human when necessary?

The thing is, we don't quite have a way to detect that right now...
Comment 6 Behdad Esfahbod 2012-03-13 07:49:53 UTC
Akira, alternatively we can just separate man pages for the return types.
Comment 7 Akira TAGOH 2012-03-13 18:46:56 UTC
(In reply to comment #6)
> Akira, alternatively we can just separate man pages for the return types.

Hmm, I'm not sure what the section number for those manpages is appropriate since 3 is for the library calls. in most cases that need to explain the members in the structures and the return values, in practice, the relevant manpages contains that description. that makes sense to understand how to use those functions and would be ideal.

That idea would be easier to auto-generate though. I'll research if there are any similar cases.
Comment 8 GitLab Migration User 2018-08-20 21:51:04 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/fontconfig/fontconfig/issues/86.


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.