Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish API reference #103

Open
okkez opened this issue Sep 30, 2016 · 4 comments
Open

Publish API reference #103

okkez opened this issue Sep 30, 2016 · 4 comments

Comments

@okkez
Copy link
Member

okkez commented Sep 30, 2016

For now comment out them

https://github.com/milter-manager/milter-manager/blob/master/doc/reference/milter-manager-docs.sgml#L61-L84

Errors like following:

../xml/milter-client-context.xml:177: parser error : error parsing attribute name
: ((<xxfi_negotiate|URL:https://www.milter.org/developers/api/xxfi_negotiate>))
                   ^

This is RD in gtk-doc style comment.
We should convert RD to gtk-doc style comment.

See also https://developer.gnome.org/gtk-doc-manual/unstable/documenting_syntax.html.en

@okkez
Copy link
Member Author

okkez commented Sep 30, 2016

We can use markdown since gtk-doc 1.20.
But CentOS6 uses gtk-doc 1.11.5.

@okkez
Copy link
Member Author

okkez commented Sep 30, 2016

We build RPM package from tarball on CentOS6.
So we can use markdown!


📝

  • doc/reference/milter-manager-sections.txt を自動生成にする
  • doc/reference/milter-manager.types を自動生成にする
  • doc/reference/milter-manager-docs.sgml に不足しているエントリを足す
  • See http://www.clear-code.com/blog/2013/12/2.html

@okkez
Copy link
Member Author

okkez commented Oct 2, 2016

  • doc/reference/html/milter-manager-libmilter/mfapi.h.html の style.css が見つからない
$ git grep -F "<rd>"
libmilter/mfapi.h:142: * <rd>
libmilter/mfapi.h:218: * <rd>
libmilter/mfapi.h:255:     * <rd>
libmilter/mfapi.h:297:     * <rd>
libmilter/mfapi.h:339:     * <rd>
libmilter/mfapi.h:388:     * <rd>
libmilter/mfapi.h:463:     * <rd>
libmilter/mfapi.h:506:     * <rd>
libmilter/mfapi.h:551:     * <rd>
libmilter/mfapi.h:601:     * <rd>
libmilter/mfapi.h:645:     * <rd>
libmilter/mfapi.h:698:     * <rd>
libmilter/mfapi.h:733:     * <rd>
libmilter/mfapi.h:786:     * <rd>
libmilter/mfapi.h:828: * <rd>
libmilter/mfapi.h:853: * <rd>
libmilter/mfapi.h:875: * <rd>
libmilter/mfapi.h:896: * <rd>
libmilter/mfapi.h:950: * <rd>
libmilter/mfapi.h:959: * <rd>
libmilter/mfapi.h:1521: * <rd>
libmilter/mfapi.h:1554: * <rd>
libmilter/mfapi.h:1580: * <rd>
libmilter/mfapi.h:1614: * <rd>
libmilter/mfapi.h:1645: * <rd>
libmilter/mfapi.h:1675: * <rd>
libmilter/mfapi.h:1702: * <rd>
libmilter/mfapi.h:1730: * <rd>
libmilter/mfapi.h:1757: * <rd>
libmilter/mfapi.h:1782: * <rd>
libmilter/mfapi.h:1806: * <rd>
libmilter/mfapi.h:1834: * <rd>
libmilter/mfapi.h:1859: * <rd>
libmilter/mfapi.h:1879: * <rd>
libmilter/mfapi.h:1902: * <rd>
milter/client.h:43: * <rd>
milter/client/milter-client-context.c:440:     * <rd>
milter/client/milter-client-context.c:536:     * <rd>
milter/client/milter-client-context.c:630:     * <rd>
milter/client/milter-client-context.c:734:     * <rd>
milter/client/milter-client-context.c:836:     * <rd>
milter/client/milter-client-context.c:933:     * <rd>
milter/client/milter-client-context.c:1048:     * <rd>
milter/client/milter-client-context.c:1144:     * <rd>
milter/client/milter-client-context.c:1247:     * <rd>
milter/client/milter-client-context.c:1359:     * <rd>
milter/client/milter-client-context.c:1467:     * <rd>

@okkez okkez mentioned this issue Oct 7, 2016
7 tasks
@okkez
Copy link
Member Author

okkez commented Oct 31, 2016

I've eliminated <rd> tags and display API reference partially.
I will work for rest APIs after next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant