Documentable


1   /*****************************************************************************
2    * Java Plug-in Framework (JPF)
3    * Copyright (C) 2004-2005 Dmitry Olshansky
4    * 
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2.1 of the License, or (at your option) any later version.
9    * 
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13   * Lesser General Public License for more details.
14   * 
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18   *****************************************************************************/
19  package org.java.plugin.registry;
20  
21  /**
22   * Interface to get access to plug-in element documentation.
23   * @version $Id: Documentable.java,v 1.1 2005/07/20 18:43:46 ddimon Exp $
24   */
25  public interface Documentable {
26      /**
27       * @return plug-in element documentation object or <code>null</code>
28       *         if there is no documentation provided
29       */
30      Documentation getDocumentation();
31      
32      /**
33       * @return path to documentation "home", it is used for resolving
34       *         documentation references
35       */
36      String   getDocsPath();
37  }
38

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags