The _aggregator_parse_opml() contains HTML tags that are escaped and appears in the text; they should be probably removed, or replaced by the correct Doxygen tag, if such tag exists.
Parse an OPML file.
Feeds are recognized as <outline> elements with the attributes
<em>text</em> and <em>xmlurl</em> set.Parameters
$opml
The complete contents of an OPML document.Return value
An array of feeds, each an associative array with a <em>title</em> and
a <em>url</em> element, or NULL if the OPML document failed to be parsed.
An empty array will be returned if the document is valid but contains
no feeds, as some OPML documents do.
Comments
Comment #1
jhodgdonThanks for reporting! Good project for a novice doc contributor to clean up this doc.
Comment #2
apadernoComment #3
apadernoI fixed a typo, and made the title more explicit.
Comment #4
amateescu CreditAttribution: amateescu commentedPatch :)
Comment #5
amateescu CreditAttribution: amateescu commentedComment #6
apadernoThe test bot is happy and so am I.
Comment #7
jhodgdonThose EM tags were put in for the purpose of highlighting/setting off those words. Perhaps they should be replaced by quotes? I think that would be a good idea.
Comment #8
montesq CreditAttribution: montesq commentedHere is the patch with double quotes instead of
<em>
. Moreover, I think the tag<outline>
should not be removed as it's not an html tag but it explains how is formed the opml file.Comment #9
apadernoshould not be removed as it's not an html tag but it explains how is formed the opml file.
That is what I think too; it is the reason the title makes reference to HTML tags.
Comment #10
jhodgdonWhen text is removed from the last paragraph, the paragraph needs to be rewrapped:
A few words should be moved up to the previous line. Otherwise, I think this patch is fine.
Comment #11
montesq CreditAttribution: montesq commentedHope this one is the finale one.
Thx for your remarks
Comment #12
apadernoDo we put an empty line between the last @param and @return?
Comment #13
jhodgdonYes, the empty line between the last @param and the @return is correct in this patch.
This new patch has some spaces at the ends of the lines in the last paragraph. Those need to go...
Comment #14
montesq CreditAttribution: montesq commentedComment #15
jhodgdonThe first changed line still ends in a space, I think?
You can configure most code-oriented text editors to show whitespace at ends of lines. That will help. In my Emacs, for instance, it is bright red and hard to miss! :)
Comment #16
montesq CreditAttribution: montesq commentedOh, I'm sorry...
I also use emacs but I didn't notice that. I need to check if this kind of configuration is in place on my personnal compture...
Moreover you talk about the last paragraph, so I didn't look at the beginning of the patch ^^
Comment #17
montesq CreditAttribution: montesq commentedComment #18
jhodgdonThanks! Now it looks good.
Emacs: put this in your emacs config file (.emacs etc. depending on platform):
'(show-trailing-whitespace t)
Comment #19
montesq CreditAttribution: montesq commented@jhodgdon
nice tip! Many Thanks
Comment #20
webchickCommitted to HEAD. Thanks!