01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.examples.readmetool;
11:
12: import org.eclipse.core.resources.IFile;
13:
14: /**
15: * This interface is used as API for the Readme parser extension
16: * point. The default implementation simply looks for lines
17: * in the file that start with a number and assumes that they
18: * represent sections. Tools are allowed to replace this
19: * algorithm by defining an extension and supplying an
20: * alternative that implements this interface.
21: */
22: public interface IReadmeFileParser {
23: /**
24: * Parses the contents of the provided file
25: * and generates a collection of sections.
26: */
27: public MarkElement[] parse(IFile readmeFile);
28: }
|