Welcome to Linux Knowledge Base and Tutorial
"The place where you learn linux"

 Create an AccountHome | Submit News | Your Account  

Tutorial Menu
Linux Tutorial Home
Table of Contents

· Introduction to Operating Systems
· Linux Basics
· Working with the System
· Shells and Utilities
· Editing Files
· Basic Administration
· The Operating System
· The X Windowing System
· The Computer Itself
· Networking
· System Monitoring
· Solving Problems
· Security
· Installing and Upgrading
· Linux and Windows

Glossary
MoreInfo
Man Pages
Linux Topics
Test Your Knowledge

Site Menu
Site Map
FAQ
Copyright Info
Terms of Use
Privacy Info
Disclaimer
WorkBoard
Thanks
Donations
Advertising
Masthead / Impressum
Your Account

Communication
Feedback
Forums
Private Messages
Surveys

Features
HOWTOs
News Archive
Submit News
Topics
User Articles
Web Links

Google
Google


The Web
linux-tutorial.info

Who's Online
There are currently, 191 guest(s) and 0 member(s) that are online.

You are an Anonymous user. You can register for free by clicking here

  

kdoc




SYNOPSIS

               kdoc [-DqpieaP] [-f format] [-n libname] [-d outdir] [-u url] [-l lib]

               kdoc [--help]

               kdoc [--version]


DESCRIPTION

       KDOC uses specially formatted comments in your C++ headers
       and CORBA IDL files to create cross-referenced documenta­
       tion in various formats.

       KDOC can also correctly handle "signal" and "slot" speci­
       fiers as used by the Qt GUI Toolkit.


EXAMPLES

               kdoc -f html -d /home/web/komdoc -n kom *.idl
               kdoc -d /home/web/kdecore
                       -u "http://www.mydomain/kdecore/"
                       -n kdecore ~/kdelibs/kdecore/*.h -lqt


OPTIONS

       --stdin, -i
           Read the filenames to process from standard input.
           Ignored if filenames are specified at the command
           line.

       --format <string>, -f <string>
           Generate output in the specific format. This can be
           used many times to generate documentation in multiple
           formats. The default format is "html".

           See the OUTPUT FORMAT OPTIONS section for a list of
           available formats.

       --outputdir <path>, -d <path>
           Write output in the specified path.

       --url <url>, -u <url>
           The URL which will be used for links when cross-refer­
           encing with this library.

       --name <string>, -n <string>
           Set the name of the library being processed, eg
           "kdecore" If no name is set, no index file is pro­
           duced.

       --xref <library>, -l <library>
           Cross-reference with the specified library. This will
           allow referencing of classes etc that exist in the
           linked library. This option can be specified multiple

           Unless --liboutdir is specified (see below), the gen­
           erated .kdoc file will be written to the first path
           specified with this option.

       --liboutdir <path>
           Set the directory where newly created xref libraries
           (see above) will be written. The default is the lib­
           dir.

       --compress, -z
           Compress generated KDOC index files with gzip to save
           space.

       --private, -p
           Document all private members. These are not documented
           by default.

       --skip-internal, -i
           Do not document internal members. They are documented
           as internal by default.

       --skip-deprecated, -e
           Do not document deprecated members. They are docu­
           mented as deprecated by default.

       --strip-h-path
           Strip the path from the filenames in the output.


PREPROCESSOR OPTIONS

       --cpp, -P
           Pass each source file through the C preprocessor. Cur­
           rently g++ is required for this, but this requirement
           will change before 2.0. Directories for inclusion in
           the preprocessor header search path can be specified
           via the -I option.

       --docincluded
           Parse files that are included by the preprocessor
           #include macro.  This is off by default.

       -cppcmd <command>, -C <command>
           Specify the preprocessor command that will be used.
           The default is:

                   g++ -Wp,-C -E

           All specified -I paths will be appended to the com­
           mand. This option quietly enables the -P option.

       --includedir <path>, -I <path>
           Add a directory to the preprocessor's header search
           Output documentation in texinfo format. You must set
           the library name with the -n option for the output to
           be generated.

       docbook
           Output documentation in the DocBook SGML format. You
           must set the library name with the -n option for the
           output to be generated.

       check
           Print a report about the documentation, eg undocu­
           mented classes and functions.

       Output format modifiers

       --html-css <url>
           In HTML format, the stylesheet specified by this
           option will be used by the generated documentation.

       --html-cols <1, 2 ..>
           In HTML format, set the number of columns for the
           Class Index.

       --html-logo <image url>
           In HTML format, specify the logo image to display on
           every page.  It will appear to the left of the quick
           links.


CROSS-REFERENCING LIBRARIES


FILES

       *.kdoc, *.kdoc.gz
           These are files that contain information about a
           library that has been processed with kdoc. It is read
           for cross-referencing with other libraries when the -l
           option is used.

           The .gz extension signifies gzipped cross-reference
           files. kdoc is capable of reading these, and generates
           them when the -z option is used.


ENVIRONMENT

       KDOCLIBS
           If this is set, it is used as the default for the
           directory where generated cross-reference index files
           are saved. See also the --libdir option.


SEE ALSO

       See qt2kdoc for info on linking with the Qt docs, and
       makekdedoc for info on generating documentation for the
       KDE libraries.


2.0a54                      2001-05-20                    KDOC(1)

An undefined database error occurred. SELECT distinct pages.pagepath,pages.pageid FROM pages, page2command WHERE pages.pageid = page2command.pageid AND commandid =


  

There are several different ways to navigate the tutorial.


Login
Nickname

Password

Security Code
Security Code
Type Security Code


Don't have an account yet? You can create one. As a registered user you have some advantages like theme manager, comments configuration and post comments with your name.

Help if you can!


Amazon Wish List

Did You Know?
The Linux Tutorial welcomes your suggestions and ideas.


Friends



Tell a Friend About Us

Bookmark and Share



Web site powered by PHP-Nuke

Is this information useful? At the very least you can help by spreading the word to your favorite newsgroups, mailing lists and forums.
All logos and trademarks in this site are property of their respective owner. The comments are property of their posters. Articles are the property of their respective owners. Unless otherwise stated in the body of the article, article content (C) 1994-2013 by James Mohr. All rights reserved. The stylized page/paper, as well as the terms "The Linux Tutorial", "The Linux Server Tutorial", "The Linux Knowledge Base and Tutorial" and "The place where you learn Linux" are service marks of James Mohr. All rights reserved.
The Linux Knowledge Base and Tutorial may contain links to sites on the Internet, which are owned and operated by third parties. The Linux Tutorial is not responsible for the content of any such third-party site. By viewing/utilizing this web site, you have agreed to our disclaimer, terms of use and privacy policy. Use of automated download software ("harvesters") such as wget, httrack, etc. causes the site to quickly exceed its bandwidth limitation and are therefore expressly prohibited. For more details on this, take a look here

PHP-Nuke Copyright © 2004 by Francisco Burzi. This is free software, and you may redistribute it under the GPL. PHP-Nuke comes with absolutely no warranty, for details, see the license.
Page Generation: 0.07 Seconds