[MonoDevelop] Better monodoc integration

[Jacob Ilsø Christensen]

Hi.

As AssemblyCodeCompletionDatabase.cs is now fixed here is my patch
against current SVN. Any comments or is it good to commit? I plan to
rename to file MonodocService.cs to DocumentationService.cs btw.

/Jacob

On 1/31/06, Lluis Sanchez <lluis at ximian.com> wrote:
> El lun, 30-01-2006 a las 22:22 +0100, Jacob Ilsø Christensen escribió:
> >
> > On 1/30/06, Lluis Sanchez <lluis at ximian.com> wrote:
> >         El lun, 30-01-2006 a las 18:10 +0100, Jacob Ilsø Christensen
> >         escribió:
> >         > Ok, here is the first attempt!
> >         >
> >         > The service has been renamed to DocumentationService and it
> >         implements
> >         > IDocumentationService which again implements IService.
> >         > IDocumentationService is placed in:
> >         >
> >         >
> >         Core/src/MonoDevelop.Projects/MonoDevelop.Projects.Documentation
> >         >
> >         > MonoDevelop.Projects no longer references
> >         MonoDevelop.Documentation
> >         > (but has to reference Monodoc).
> >
> >         This reference shouldn't be needed. I guess it is due to the
> >         HelpTree
> >         property in IDocumentationService which returns a type from
> >         Monodoc,
> >         right? Since this property is not used in MonoDevelop.Projects
> >         it could
> >         be removed from the interface (but not from the class).
> >
> >         However, MonoDevelop.Ide does use that property. I see two
> >         solutions for
> >         this.
> >
> >               * The easy one: In MonoDevelop.Ide use the class
> >                 DocumentationService instead of IDocumentationService
> >         (it is
> >                 possible to reference MonoDevelop.Documentation
> >         there).
> >               * The complex/good one: Move HelpViewer and
> >         MonodocTreePad from
> >                 MonoDevelop.Ide to MonoDevelop.Documentation. Move the
> >         handling
> >                 of the F1 key from MonoDevelop.SourceEditor to
> >                 MonoDevelop.Documentation.
> >
> >         In any case those changes don't need to be done right now.
> >         Removing the
> >         MonoDevelop.Documentation dependency is a first step. Removing
> >         the
> >         Monodoc can be done in a later step.
> >
> >         > Instead MonoDevelop.Documentation references
> >         MonoDevelop.Projects.
> >         >
> >         > I have one issue in:
> >         >
> >         >
> >         Core/src/MonoDevelop.Projects/MonoDevelop.Projects.Parser/AssemblyCodeCompletionDatabase.cs
> >         >
> >         > Here a new instance of MonodocService is made. This is no
> >         longer
> >         > possible due to the broken dependency. I need some help as
> >         to how to
> >         > resolve this. Maybe it is not necessary as the
> >         ServiceManager does
> >         > this?
> >
> >         Yes, the service should be created through the service
> >         manager. I'll
> >         take a look at this.
> >
> > Sounds good. So shall I commit the stuff now or wait for you to look
> > into this? I'll fix the MonoDevelop.Projects reference to monodoc
> > afterwards then.
>
> Please hold the patch until I fix AssemblyCodeCompletionDatabase.cs,
> since it would break code completion.
>
> Lluis.
>
> >
>
>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: documentation.patch
Type: text/x-patch
Size: 12547 bytes
Desc: not available
Url : http://lists.ximian.com/pipermail/monodevelop-list/attachments/20060312/6dff663d/documentation-0001.bin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: IDocumentationService.cs
Type: text/x-csharp
Size: 1052 bytes
Desc: not available
Url : http://lists.ximian.com/pipermail/monodevelop-list/attachments/20060312/6dff663d/IDocumentationService-0001.bin