documentation.txt

来自「一个类似STL的自动机的源代码库」· 文本 代码 · 共 74 行

/*
 * ASTL - the Automaton Standard Template Library.
 * C++ generic components for Finite State Machine handling.
 * Copyright (C) 2000 Vincent Le Maout ([e-mail]).
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

This file provides templates for code documentation based on the
SGI STL documentation at http://www.sgi.com/Technology/STL.

Template for algorithm documentation:

// Category:       Algorithms
// Component Type: Function
// Prototype:
// Description:
// Return value:
// Definition:
// Requirements on types:
// Preconditions:
// Complexity:
// Example:
// Notes:
// Bugs and limitations:
// See also:

Template for model documentation:

// Category: 
// Component Type: Type
// Description:
// Definition:
// Example:
// Template parameters:
// Model of:
// Type requirements:
// Public base classes:
// Members:
// New members:
// Notes:
// Bugs and limitations:
// See also:

Template for concept documentation:

// Category: 
// Component Type: Concept
// Description:
// Refinement of:
// Associated types:
// Notations:
// Definitions:
// Valid expressions:
// Expression semantics:
// Complexity guarantees:
// Invariants:
// Models:
// Notes:
// See also: