diff options
| author | 2009-07-25 18:12:49 +0200 | |
|---|---|---|
| committer | 2009-07-25 18:12:49 +0200 | |
| commit | da94f0ebc7232e8e9d0e629fe559b7bc93d9a1c6 (patch) | |
| tree | 30d2087ecbc46538ffffda56e075b4242040914b | |
| parent | 0e255cfe381caedf0375e6834021333d971f8050 (diff) | |
| download | libimobiledevice-da94f0ebc7232e8e9d0e629fe559b7bc93d9a1c6.tar.gz libimobiledevice-da94f0ebc7232e8e9d0e629fe559b7bc93d9a1c6.tar.bz2 | |
Update doxygen config and allow generation of documentation
| -rw-r--r-- | doxygen.cfg | 269 | ||||
| -rw-r--r-- | include/libiphone/afc.h | 6 | ||||
| -rw-r--r-- | include/libiphone/libiphone.h | 7 | ||||
| -rw-r--r-- | include/libiphone/lockdown.h | 7 | ||||
| -rw-r--r-- | include/libiphone/mobilesync.h | 8 | ||||
| -rw-r--r-- | include/libiphone/notification_proxy.h | 6 | 
6 files changed, 218 insertions, 85 deletions
| diff --git a/doxygen.cfg b/doxygen.cfg index 990802c..0942031 100644 --- a/doxygen.cfg +++ b/doxygen.cfg @@ -1,4 +1,4 @@ -# Doxyfile 1.5.3 +# Doxyfile 1.5.6  # This file describes the settings to be used by the documentation system  # doxygen (www.doxygen.org) for a project @@ -14,11 +14,11 @@  # Project related configuration options  #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file that  -# follow. The default is UTF-8 which is also the encoding used for all text before  -# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into  -# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of  -# possible encodings. +# This tag specifies the encoding used for all characters in the config file  +# that follow. The default is UTF-8 which is also the encoding used for all  +# text before the first occurrence of this tag. Doxygen uses libiconv (or the  +# iconv built into libc) for the transcoding. See  +# http://www.gnu.org/software/libiconv for the list of possible encodings.  DOXYFILE_ENCODING      = UTF-8 @@ -31,7 +31,7 @@ PROJECT_NAME           = libiphone  # This could be handy for archiving the generated documentation or   # if some version control system is used. -PROJECT_NUMBER         = 0.1.0 +PROJECT_NUMBER         = 0.9.1  # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)   # base path where the generated documentation will be put.  @@ -54,10 +54,11 @@ CREATE_SUBDIRS         = NO  # information to generate all constant output in the proper language.   # The default language is English, other supported languages are:   # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,  -# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,  -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,  -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,  -# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek,  +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages),  +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish,  +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,  +# and Ukrainian.  OUTPUT_LANGUAGE        = English @@ -113,7 +114,7 @@ FULL_PATH_NAMES        = YES  # If left blank the directory from which doxygen is run is used as the   # path to strip. -STRIP_FROM_PATH        =  +STRIP_FROM_PATH        = include  # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of   # the path mentioned in the documentation of a class, which tells  @@ -195,14 +196,26 @@ ALIASES                =  OPTIMIZE_OUTPUT_FOR_C  = YES  # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java  -# sources only. Doxygen will then generate output that is more tailored for Java.  -# For instance, namespaces will be presented as packages, qualified scopes  -# will look different, etc. +# sources only. Doxygen will then generate output that is more tailored for  +# Java. For instance, namespaces will be presented as packages, qualified  +# scopes will look different, etc.  OPTIMIZE_OUTPUT_JAVA   = NO -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to  -# include (a tag file for) the STL sources as input, then you should  +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran  +# sources only. Doxygen will then generate output that is more tailored for  +# Fortran. + +OPTIMIZE_FOR_FORTRAN   = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL  +# sources. Doxygen will then generate output that is tailored for  +# VHDL. + +OPTIMIZE_OUTPUT_VHDL   = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want  +# to include (a tag file for) the STL sources as input, then you should   # set this tag to YES in order to let doxygen match functions declarations and   # definitions whose arguments contain STL classes (e.g. func(std::string); v.s.   # func(std::string) {}). This also make the inheritance and collaboration  @@ -215,6 +228,21 @@ BUILTIN_STL_SUPPORT    = NO  CPP_CLI_SUPPORT        = NO +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.  +# Doxygen will parse them like normal C++ but will assume all classes use public  +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT            = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter  +# and setter methods for a property. Setting this option to YES (the default)  +# will make doxygen to replace the get and set methods by a property in the  +# documentation. This will only work if the methods are indeed getting or  +# setting a simple type. If this is not the case, or you want to show the  +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT   = YES +  # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC   # tag is set to YES, then doxygen will reuse the documentation of the first   # member in the group (if any) for the other members of the group. By default  @@ -228,7 +256,17 @@ DISTRIBUTE_GROUP_DOC   = NO  # NO to prevent subgrouping. Alternatively, this can be done per class using   # the \nosubgrouping command. -SUBGROUPING            = YES +SUBGROUPING            = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum  +# is documented as struct, union, or enum with the name of the typedef. So  +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct  +# with name TypeT. When disabled the typedef will appear as a member of a file,  +# namespace, or class. And the struct will be named TypeS. This can typically  +# be useful for C code in case the coding convention dictates that all compound  +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT   = YES  #---------------------------------------------------------------------------  # Build related configuration options @@ -239,7 +277,7 @@ SUBGROUPING            = YES  # Private class members and static file members will be hidden unless   # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL            = YES +EXTRACT_ALL            = NO  # If the EXTRACT_PRIVATE tag is set to YES all private members of a class   # will be included in the documentation. @@ -255,7 +293,7 @@ EXTRACT_STATIC         = NO  # defined locally in source files will be included in the documentation.   # If set to NO only classes defined in header files are included. -EXTRACT_LOCAL_CLASSES  = YES +EXTRACT_LOCAL_CLASSES  = NO  # This flag is only useful for Objective-C code. When set to YES local   # methods, which are defined in the implementation section but not in  @@ -264,10 +302,11 @@ EXTRACT_LOCAL_CLASSES  = YES  EXTRACT_LOCAL_METHODS  = NO -# If this flag is set to YES, the members of anonymous namespaces will be extracted  -# and appear in the documentation as a namespace called 'anonymous_namespace{file}',  -# where file will be replaced with the base name of the file that contains the anonymous  -# namespace. By default anonymous namespace are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be  +# extracted and appear in the documentation as a namespace called  +# 'anonymous_namespace{file}', where file will be replaced with the base  +# name of the file that contains the anonymous namespace. By default  +# anonymous namespace are hidden.  EXTRACT_ANON_NSPACES   = NO @@ -313,7 +352,7 @@ INTERNAL_DOCS          = NO  # in case and if your file system supports case sensitive file names. Windows   # and Mac users are advised to set this option to NO. -CASE_SENSE_NAMES       = YES +CASE_SENSE_NAMES       = NO  # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen   # will show members with their full class and namespace scopes in the  @@ -325,7 +364,7 @@ HIDE_SCOPE_NAMES       = NO  # will put a list of the files that are included by a file in the documentation   # of that file. -SHOW_INCLUDE_FILES     = YES +SHOW_INCLUDE_FILES     = NO  # If the INLINE_INFO tag is set to YES (the default) then a tag [inline]   # is inserted in the documentation for inline members. @@ -346,6 +385,12 @@ SORT_MEMBER_DOCS       = YES  SORT_BRIEF_DOCS        = NO +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the  +# hierarchy of group names into alphabetical order. If set to NO (the default)  +# the group names will appear in their defined order. + +SORT_GROUP_NAMES       = NO +  # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be   # sorted by fully-qualified names, including namespaces. If set to   # NO (the default), the class list will be sorted only by class name,  @@ -407,9 +452,21 @@ SHOW_USED_FILES        = YES  SHOW_DIRECTORIES       = NO +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the  +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES             = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the  +# Namespaces page.  This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES        = YES +  # The FILE_VERSION_FILTER tag can be used to specify a program or script that  -# doxygen should invoke to get the current version for each file (typically from the  -# version control system). Doxygen will invoke the program by executing (via  +# doxygen should invoke to get the current version for each file (typically from  +# the version control system). Doxygen will invoke the program by executing (via   # popen()) the command <command> <input-file>, where <command> is the value of   # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file   # provided by doxygen. Whatever the program writes to standard output  @@ -477,12 +534,13 @@ WARN_LOGFILE           =  # directories like "/usr/src/myproject". Separate the files or directories   # with spaces. -INPUT                  = src +INPUT                  = src include/libiphone -# This tag can be used to specify the character encoding of the source files that  -# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default  -# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.  -# See http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag can be used to specify the character encoding of the source files  +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is  +# also the default input encoding. Doxygen uses libiconv (or the iconv built  +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for  +# the list of possible encodings.  INPUT_ENCODING         = UTF-8 @@ -491,7 +549,7 @@ INPUT_ENCODING         = UTF-8  # and *.h) to filter out the source-files in the directories. If left   # blank the following patterns are tested:   # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx  -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90  FILE_PATTERNS          =  @@ -505,7 +563,7 @@ RECURSIVE              = NO  # excluded from the INPUT source files. This way you can easily exclude a   # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE                = src/main.c src/ifuse.c +EXCLUDE                = dev  # The EXCLUDE_SYMLINKS tag can be used select whether or not files or   # directories that are symbolic links (a Unix filesystem feature) are excluded  @@ -522,9 +580,10 @@ EXCLUDE_SYMLINKS       = NO  EXCLUDE_PATTERNS       =   # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names  -# (namespaces, classes, functions, etc.) that should be excluded from the output.  -# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,  -# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test +# (namespaces, classes, functions, etc.) that should be excluded from the  +# output. The symbol name can be a fully qualified name, a word, or if the  +# wildcard * is used, a substring. Examples: ANamespace, AClass,  +# AClass::ANamespace, ANamespace::*Test  EXCLUDE_SYMBOLS        =  @@ -586,11 +645,9 @@ FILTER_SOURCE_FILES    = NO  # If the SOURCE_BROWSER tag is set to YES then a list of source files will   # be generated. Documented entities will be cross-referenced with these sources.   # Note: To get rid of all source code in the generated output, make sure also  -# VERBATIM_HEADERS is set to NO. If you have enabled CALL_GRAPH or CALLER_GRAPH  -# then you must also enable this option. If you don't then doxygen will produce  -# a warning and turn it on anyway +# VERBATIM_HEADERS is set to NO. -SOURCE_BROWSER         = YES +SOURCE_BROWSER         = NO  # Setting the INLINE_SOURCES tag to YES will include the body   # of functions and classes directly in the documentation. @@ -603,13 +660,13 @@ INLINE_SOURCES         = NO  STRIP_CODE_COMMENTS    = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default)  +# If the REFERENCED_BY_RELATION tag is set to YES   # then for each documented function all documented   # functions referencing it will be listed.  REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default)  +# If the REFERENCES_RELATION tag is set to YES   # then for each documented function all documented entities   # called/used by that function will be listed. @@ -634,7 +691,7 @@ USE_HTAGS              = NO  # will generate a verbatim copy of the header file for each class for   # which an include is specified. Set to NO to disable this. -VERBATIM_HEADERS       = YES +VERBATIM_HEADERS       = NO  #---------------------------------------------------------------------------  # configuration options related to the alphabetical class index @@ -709,11 +766,36 @@ HTML_ALIGN_MEMBERS     = YES  # If the GENERATE_HTMLHELP tag is set to YES, additional index files   # will be generated that can be used as input for tools like the  -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)  +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)   # of the generated HTML documentation.  GENERATE_HTMLHELP      = NO +# If the GENERATE_DOCSET tag is set to YES, additional index files  +# will be generated that can be used as input for Apple's Xcode 3  +# integrated development environment, introduced with OSX 10.5 (Leopard).  +# To create a documentation set, doxygen will generate a Makefile in the  +# HTML output directory. Running make will produce the docset in that  +# directory and running "make install" will install the docset in  +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find  +# it at startup. + +GENERATE_DOCSET        = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the  +# feed. A documentation feed provides an umbrella under which multiple  +# documentation sets from a single provider (such as a company or product suite)  +# can be grouped. + +DOCSET_FEEDNAME        = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that  +# should uniquely identify the documentation set bundle. This should be a  +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen  +# will append .docset to the name. + +DOCSET_BUNDLE_ID       = org.doxygen.Project +  # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML   # documentation will contain sections that can be hidden and shown after the   # page has loaded. For this to work a browser that supports  @@ -742,6 +824,12 @@ HHC_LOCATION           =  GENERATE_CHI           = NO +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING     =  +  # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag   # controls whether a binary table of contents is generated (YES) or a   # normal table of contents (NO) in the .chm file. @@ -764,14 +852,22 @@ DISABLE_INDEX          = NO  ENUM_VALUES_PER_LINE   = 4 -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that  +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to FRAME, a side panel will be generated +# containing a tree-like index structure (just like the one that   # is generated for HTML Help). For this to work a browser that supports   # JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,   # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are  -# probably better off using the HTML help feature. +# probably better off using the HTML help feature. Other possible values  +# for this tag are: HIERARCHIES, which will generate the Groups, Directories, +# and Class Hiererachy pages using a tree view instead of an ordered list; +# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which +# disables this behavior completely. For backwards compatibility with previous +# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE +# respectively. -GENERATE_TREEVIEW      = YES +GENERATE_TREEVIEW      = NONE  # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be   # used to set the initial width (in pixels) of the frame in which the tree  @@ -779,6 +875,14 @@ GENERATE_TREEVIEW      = YES  TREEVIEW_WIDTH         = 250 +# Use this tag to change the font size of Latex formulas included  +# as images in the HTML documentation. The default is 10. Note that  +# when you change the font size after a successful doxygen run you need  +# to manually remove any form_*.png images from the HTML output directory  +# to force them to be regenerated. + +FORMULA_FONTSIZE       = 10 +  #---------------------------------------------------------------------------  # configuration options related to the LaTeX output  #--------------------------------------------------------------------------- @@ -1031,7 +1135,7 @@ EXPAND_ONLY_PREDEF     = NO  # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files   # in the INCLUDE_PATH (see below) will be search if a #include is found. -SEARCH_INCLUDES        = YES +SEARCH_INCLUDES        = NO  # The INCLUDE_PATH tag can be used to specify one or more directories that   # contain include files that are not input files but should be processed by  @@ -1128,10 +1232,11 @@ PERL_PATH              = /usr/bin/perl  CLASS_DIAGRAMS         = YES  # You can define message sequence charts within doxygen comments using the \msc  -# command. Doxygen will then run the mscgen tool (see http://www.mcternan.me.uk/mscgen/) to  -# produce the chart and insert it in the documentation. The MSCGEN_PATH tag allows you to  -# specify the directory where the mscgen tool resides. If left empty the tool is assumed to  -# be found in the default search path. +# command. Doxygen will then run the mscgen tool (see  +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the  +# documentation. The MSCGEN_PATH tag allows you to specify the directory where  +# the mscgen tool resides. If left empty the tool is assumed to be found in the  +# default search path.  MSCGEN_PATH            =  @@ -1148,6 +1253,24 @@ HIDE_UNDOC_RELATIONS   = YES  HAVE_DOT               = NO +# By default doxygen will write a font called FreeSans.ttf to the output  +# directory and reference it in all dot files that doxygen generates. This  +# font does not include all possible unicode characters however, so when you need  +# these (or just want a differently looking font) you can specify the font name  +# using DOT_FONTNAME. You need need to make sure dot is able to find the font,  +# which can be done by putting it in a standard location or by setting the  +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory  +# containing the font. + +DOT_FONTNAME           = FreeSans + +# By default doxygen will tell dot to use the output directory to look for the  +# FreeSans.ttf font (which doxygen will put there itself). If you specify a  +# different font using DOT_FONTNAME you can set the path where dot  +# can find it using this tag. + +DOT_FONTPATH           =  +  # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen   # will generate a graph for each documented class showing the direct and   # indirect inheritance relations. Setting this tag to YES will force the  @@ -1192,19 +1315,19 @@ INCLUDE_GRAPH          = YES  INCLUDED_BY_GRAPH      = YES -# If the CALL_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will  -# generate a call dependency graph for every global function or class method.  -# Note that enabling this option will significantly increase the time of a run.  -# So in most cases it will be better to enable call graphs for selected  -# functions only using the \callgraph command. +# If the CALL_GRAPH and HAVE_DOT options are set to YES then  +# doxygen will generate a call dependency graph for every global function  +# or class method. Note that enabling this option will significantly increase  +# the time of a run. So in most cases it will be better to enable call graphs  +# for selected functions only using the \callgraph command.  CALL_GRAPH             = NO -# If the CALLER_GRAPH, SOURCE_BROWSER and HAVE_DOT tags are set to YES then doxygen will  -# generate a caller dependency graph for every global function or class method.  -# Note that enabling this option will significantly increase the time of a run.  -# So in most cases it will be better to enable caller graphs for selected  -# functions only using the \callergraph command. +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then  +# doxygen will generate a caller dependency graph for every global function  +# or class method. Note that enabling this option will significantly increase  +# the time of a run. So in most cases it will be better to enable caller  +# graphs for selected functions only using the \callergraph command.  CALLER_GRAPH           = NO @@ -1237,12 +1360,12 @@ DOT_PATH               =  DOTFILE_DIRS           =  -# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of  +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of   # nodes that will be shown in the graph. If the number of nodes in a graph   # becomes larger than this value, doxygen will truncate the graph, which is  -# visualized by representing a node as a red box. Note that doxygen if the number  -# of direct children of the root node in a graph is already larger than  -# MAX_DOT_GRAPH_NOTES then the graph will not be shown at all. Also note  +# visualized by representing a node as a red box. Note that doxygen if the  +# number of direct children of the root node in a graph is already larger than  +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note   # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.  DOT_GRAPH_MAX_NODES    = 50 @@ -1258,10 +1381,10 @@ DOT_GRAPH_MAX_NODES    = 50  MAX_DOT_GRAPH_DEPTH    = 0  # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent  -# background. This is disabled by default, which results in a white background.  -# Warning: Depending on the platform used, enabling this option may lead to  -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to  -# read). +# background. This is enabled by default, which results in a transparent  +# background. Warning: Depending on the platform used, enabling this option  +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they  +# become hard to read).  DOT_TRANSPARENT        = NO diff --git a/include/libiphone/afc.h b/include/libiphone/afc.h index 08122a1..71730cc 100644 --- a/include/libiphone/afc.h +++ b/include/libiphone/afc.h @@ -1,5 +1,7 @@ -/* - * afc.h +/** + * @file libiphone/afc.h + * @brief AFC Implementation + * \internal   *   * Copyright (c) 2009 Nikias Bassen All Rights Reserved.   * diff --git a/include/libiphone/libiphone.h b/include/libiphone/libiphone.h index 014c8bf..1451f15 100644 --- a/include/libiphone/libiphone.h +++ b/include/libiphone/libiphone.h @@ -1,6 +1,7 @@ -/* - * libiphone.h - * Main include of libiphone +/** + * @file libiphone/libiphone.h + * @brief Common code and device handling + * \internal   *   * Copyright (c) 2008 Jonathan Beck All Rights Reserved.   * diff --git a/include/libiphone/lockdown.h b/include/libiphone/lockdown.h index 55c0cb7..daa5800 100644 --- a/include/libiphone/lockdown.h +++ b/include/libiphone/lockdown.h @@ -1,6 +1,9 @@ -/* - * lockdownd.h +/** + * @file libiphone/lockdown.h + * @brief Communcation with the lockdown device daemon + * \internal   * + * Copyright (c) 2008 Zach C. All Rights Reserved.   * Copyright (c) 2009 Martin S. All Rights Reserved.   *   * This library is free software; you can redistribute it and/or diff --git a/include/libiphone/mobilesync.h b/include/libiphone/mobilesync.h index f8fa711..662036c 100644 --- a/include/libiphone/mobilesync.h +++ b/include/libiphone/mobilesync.h @@ -1,7 +1,9 @@ -/* - * mobilesync.h +/** + * @file libiphone/mobilesync.h + * @brief MobileSync Implementation + * \internal   * - * Copyright (c) 2009 Martin S. All Rights Reserved. + * Copyright (c) 2009 Jonathan Beck All Rights Reserved.   *   * This library is free software; you can redistribute it and/or   * modify it under the terms of the GNU Lesser General Public diff --git a/include/libiphone/notification_proxy.h b/include/libiphone/notification_proxy.h index 520ccd1..66b7a80 100644 --- a/include/libiphone/notification_proxy.h +++ b/include/libiphone/notification_proxy.h @@ -1,5 +1,7 @@ -/* - * notification_proxy.h +/** + * @file libiphone/notification_proxy.h + * @brief Implementation to talk to the notification proxy on a device + * \internal   *   * Copyright (c) 2009 Nikias Bassen All Rights Reserved.   * | 
