[Mono-bugs] [Bug 468694] [Regression] Can't see anything in the right pane of monodoc

[bugzilla_noreply at novell.com]

https://bugzilla.novell.com/show_bug.cgi?id=468694

User jpryor at novell.com added comment
https://bugzilla.novell.com/show_bug.cgi?id=468694#c2





--- Comment #2 from Jonathan Pryor <jpryor at novell.com>  2009-01-22 19:48:05 MST ---
This is an HTML renderer issue.

Specifically, `monodoc --engine GtkHtml` shows actual content in the right
pane.

Presumably, `monodoc -engine WebKit` would work as well (as openSUSE 11.1's
monodoc is using WebKit), but WebKit doesn't work in my parallel build.

Thus it's the MonoWebBrowser HTML browser which is at fault (since GtkHtml is
working).

Furthermore, for HTML rendering you can ignore the "node .* is not defined on
the documentation map" messages.  Those messages refer to "bad"
$prefix/lib/monodoc/sources/*.source files.

Specifically, e.g. Gendarme.Rules.BadPractice.source contains:

  <monodoc>
    <source provider='ecma' basefile='Gendarme.Rules.BadPractice'
      path='ruleslib-Gendarme.Rules.BadPractice'/>
  </monodoc>

This isn't valid as the //source/@path value hasn't been created in the tree,
and thus monodoc doesn't know where to insert that documentation node.  The
solution is to add a /monodoc/node element, e.g.

  <monodoc>
    <node label="Gendarme Libraries" name="ruleslib-Gendarme" 
      parent="Libraries">
      <node label="Bad Practice" name="ruleslib-Gendarme.Rules.BadPractice" />
    </node>
    <source provider='ecma' basefile='Gendarme.Rules.BadPractice'
      path='ruleslib-Gendarme.Rules.BadPractice'/>
  </monodoc>

-- 
Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.