Comment 1 Hiroyuki 2009-01-12 01:32:27 EST

Created attachment 122233 [details]
org.eclipse.mylyn.help.isv.zip

This project is a sample of the help plug-in for API Reference (javadoc) and extension point reference. 
The document under the reference folder can be made with buildDoc.xml.

Comment 2 Steffen Pingel 2009-01-12 13:57:03 EST

Contents of the plug-in help toc:

<toc label="Mylyn Developer Guide">
<topic label="Architecture Overview" href="http://wiki.eclipse.org/Mylyn/Architecture"/>
<topic label="Contributor Reference" href="http://wiki.eclipse.org/Mylyn/Contributor_Reference"/>
<topic label="Integrator Reference" href="http://wiki.eclipse.org/Mylyn/Integrator_Reference"/>
<topic label="Porting Guide" href="http://wiki.eclipse.org/Mylyn/Porting_Guide"/>
?
<topic label="API Reference"/>

Comment 3 Hiroyuki 2009-01-13 10:50:54 EST

It is necessary to guide it to the document for development. 
For example; it is the architecture, etc.

The topic saw and made Developer Reference of http://wiki.eclipse.org/Mylyn

Comment 4 Steffen Pingel 2009-01-15 14:14:01 EST

As per last conference call we agreed to add a new plug-in org.eclipse.mylyn.help.sdk for developer documentation.

Comment 5 Steffen Pingel 2009-04-23 01:44:45 EDT

Committed plug-in to cvs. I have excluded Javadoc generation for provisional API and WikiText for now but it could make sense to enable that as well depending on how this will be structured in the end. I have added an item to the meeting agenda to discuss this further.

Todo: Add plugin to map files, sdk feature and psf files.

Comment 6 Steffen Pingel 2009-04-23 01:45:24 EDT

Created attachment 132883 [details]
screenshot

Comment 7 Hiroyuki 2009-04-23 10:34:12 EDT

The external javadoc of Mylyn cannot be opened. 
The following definitions are necessary for plugin.xml of org.eclipse.mylyn.help.sdk.

   <extension point="org.eclipse.pde.core.javadoc">
      <javadoc path="reference/api">
         <plugin id="org.eclipse.mylyn.commons.core" />
         <plugin id="org.eclipse.mylyn.commons.net" />
         <plugin id="org.eclipse.mylyn.context.core" />
         <plugin id="org.eclipse.mylyn.context.ui" />
         <plugin id="org.eclipse.mylyn.ide.ui" />
         <plugin id="org.eclipse.mylyn.monitor.core" />
         <plugin id="org.eclipse.mylyn.monitor.ui" />
         <plugin id="org.eclipse.mylyn.resources.ui" />
         <plugin id="org.eclipse.mylyn.tasks.core" />
         <plugin id="org.eclipse.mylyn.tasks.core.data" />
         <plugin id="org.eclipse.mylyn.tasks.core.sync" />   
         <plugin id="org.eclipse.mylyn.tasks.ui" />
         <plugin id="org.eclipse.mylyn.tasks.ui.editors" />
         <plugin id="org.eclipse.mylyn.tasks.ui.propertysheet" />   
         <plugin id="org.eclipse.mylyn.tasks.ui.wizards" />   
         <plugin id="org.eclipse.mylyn.team.ui" /> 
      </javadoc>
   </extension>

Comment 8 Steffen Pingel 2009-04-23 14:20:14 EDT

Thanks for pointing that out, I was wondering where that extension point was actually used. I have added the extensions.

As discussed on today's call I'm moving this bug to the next milestone. There are too many blanks in the current documentation to make it worth while publishing the generated Javadoc or extension point documentation at this point. Once the documentation has been improved we can reconsider including the plug-in in the SDK feature.

Comment 9 Steffen Pingel 2009-04-23 14:20:17 EDT

Created attachment 132992 [details]
mylyn/context/zip

Comment 10 Steffen Pingel 2009-06-20 15:33:56 EDT

We still don't have sufficient (API) documentation. Moving to back log for future consideration.

Comment 11 Eclipse Webmaster 2022-11-15 11:45:08 EST

Mylyn has been restructured, and our issue tracking has moved to GitHub [1].

We are closing ~14K Bugzilla issues to give the new team a fresh start. If you feel that this issue is still relevant, please create a new one on GitHub.

[1] https://github.com/orgs/eclipse-mylyn