/usr/share/freefoam/utilities/extractBrief is in libfreefoam-dev 0.1.0+dfsg-1build1.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | #!/usr/bin/python
#-------------------------------------------------------------------------------
# ______ _ ____ __ __
# | ____| _| |_ / __ \ /\ | \/ |
# | |__ _ __ ___ ___ / \| | | | / \ | \ / |
# | __| '__/ _ \/ _ ( (| |) ) | | |/ /\ \ | |\/| |
# | | | | | __/ __/\_ _/| |__| / ____ \| | | |
# |_| |_| \___|\___| |_| \____/_/ \_\_| |_|
#
# FreeFOAM: The Cross-Platform CFD Toolkit
#
# Copyright (C) 2008-2012 Michael Wild <themiwi@users.sf.net>
# Gerber van der Graaf <gerber_graaf@users.sf.net>
#-------------------------------------------------------------------------------
# License
# This file is part of FreeFOAM.
#
# FreeFOAM is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation, either version 3 of the License, or (at your
# option) any later version.
#
# FreeFOAM 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 General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License
# along with FreeFOAM. If not, see <http://www.gnu.org/licenses/>.
#
# Script
# extractBrief
#
# Description
# Extracts the brief description from the header comment of an application
# source file and converts it to AsciiDoc code. The output is written to
# standard output.
#
#------------------------------------------------------------------------------
"""Usage: extractBrief <name> <file>
Extracts the brief description from the header comment of an application
source file and converts it to AsciiDoc code. The output is written to
standard output.
Options
-------
-h
-help Display this help message
<name> Name of the application.
<file> The source file to to process.
"""
import sys
import os.path
sys.path.insert(0, '/usr/lib/python2.7/site-packages')
import FreeFOAM.doxyToAsciidoc
from FreeFOAM.compat import *
args = sys.argv[1:]
while len(args) > 0:
a = args[0]
if a == '-h' or a == '-help':
echo(__doc__)
sys.exit(0)
else:
break
if len(args) != 2:
echo('Error: the name and input file required arguments', file=sys.stderr)
sys.exit(1)
name = args[0]
source = args[1]
if not os.path.isfile(source):
echo('Error: "%s" does not exist or is not a file'%source, file=sys.stderr)
sys.exit(1)
# parse the header comments
doc = FreeFOAM.doxyToAsciidoc.Parser(source).parse()
brief = ' '.join(doc['brief']).strip()
if brief[-1] != '.':
brief += '.'
echo('*linkff:%s[1]*::\n %s'%(name, brief))
# ------------------------- vim: set sw=3 sts=3 et: --------------- end-of-file
|