01: /*****************************************************************************
02: * Java Plug-in Framework (JPF)
03: * Copyright (C) 2004-2007 Dmitry Olshansky
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
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: *****************************************************************************/package org.java.plugin.registry;
19:
20: /**
21: * Interface to get access to plug-in element documentation.
22: * @param <T> type of identity to be documented
23: * @version $Id$
24: */
25: public interface Documentable<T extends Identity> {
26: /**
27: * @return plug-in element documentation object or <code>null</code>
28: * if there is no documentation provided
29: */
30: Documentation<T> getDocumentation();
31:
32: /**
33: * @return path to documentation "home", it is used for resolving
34: * documentation references
35: */
36: String getDocsPath();
37: }
|