1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef AUTODOC_PRS_CODE_HXX 25 #define AUTODOC_PRS_CODE_HXX 26 27 28 29 namespace csv 30 { 31 namespace ploc 32 { 33 class Path; 34 } 35 } 36 37 namespace ary 38 { 39 class Repository; 40 } 41 42 namespace autodoc 43 { 44 class FileCollector_Ifc; 45 class DocumentationParser_Ifc; 46 47 48 49 50 /** Interface for parsing code of a programming language and 51 delivering the information into an Autodoc Repository. 52 **/ 53 class CodeParser_Ifc 54 { 55 public: ~CodeParser_Ifc()56 virtual ~CodeParser_Ifc() {} 57 58 virtual void Setup( 59 ary::Repository & o_rRepository, 60 const autodoc::DocumentationParser_Ifc & 61 i_rDocumentationInterpreter ) = 0; 62 63 virtual void Run( 64 const autodoc::FileCollector_Ifc & 65 i_rFiles ) = 0; 66 }; 67 68 69 70 71 } // namespace autodoc 72 #endif 73