[Poppler-bugs] [Bug 45384] Various minor introspection improvements

[bugzilla-daemon at freedesktop.org]

https://bugs.freedesktop.org/show_bug.cgi?id=45384

Evan Nemerson <evan at coeus-group.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
  Attachment #56312|0                           |1
        is obsolete|                            |

--- Comment #4 from Evan Nemerson <evan at coeus-group.com> ---
Created attachment 74809
  --> https://bugs.freedesktop.org/attachment.cgi?id=74809&action=edit
glib: add documentation for PopplerActions

> ::: glib/poppler-action.h
> @@ +261,5 @@
> >  };
> >  
> > +/**
> > + * PopplerActionOCGState:
> > + * @type: action type
> 
> We know the action type, so add it in parentheses:
> 
> @type: action type (%POPPLER_ACTION_OCG_STATE)

Okay, done for all of them.

> @@ +263,5 @@
> > +/**
> > + * PopplerActionOCGState:
> > + * @type: action type
> > + * @title: action title
> > + * @state_list: (element-type PopplerActionLayer): list of #PopplerActionLayer<-- -->s
> 
> We should explain briefly what this action is for.

I honestly have no idea what this action is for.  Or any of them, really.  I'm
not at all familiar with the Poppler API, just trying to get introspection up
to snuff.

I've copied what could be called, if you're feeling generous, brief
explanations from the PopplerActionType enum, but it would be nice if someone
who knows the API could improve it.

> @@ +264,5 @@
> > + * PopplerActionOCGState:
> > + * @type: action type
> > + * @title: action title
> > + * @state_list: (element-type PopplerActionLayer): list of #PopplerActionLayer<-- -->s
> > + */
> 
> All other action types are also undocumented, I guess it's a good time to
> document all of them :-P

I've done what I can.  To be honest I haven't really added any insight, but it
should look a little better than empty docs.

-- 
You are receiving this mail because:
You are the assignee for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/poppler-bugs/attachments/20130214/7fb9470b/attachment.html>