Changeset 4e59276 in rtems


Ignore:
Timestamp:
Dec 28, 2012, 2:05:20 PM (7 years ago)
Author:
Mathew Kallada <matkallada@…>
Branches:
4.11, master
Children:
8587b01
Parents:
36f3207
git-author:
Mathew Kallada <matkallada@…> (12/28/12 14:05:20)
git-committer:
Jennifer Averett <jennifer.averett@…> (12/28/12 14:05:20)
Message:

libfs: Doxygen Enhancement Task #5

Location:
cpukit/libfs/src
Files:
23 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libfs/src/defaults/default_fcntl.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief RTEMS Default Filesystem - Default FCNTL
     5 * @ingroup libfs
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 2010.
  • cpukit/libfs/src/defaults/default_freenode.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief RTEMS Default Filesystem - Default Freenode
     5 * @ingroup libfs
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 2010.
  • cpukit/libfs/src/defaults/default_ftruncate_directory.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief RTEMS Default Filesystem - Default Ftruncate Directory
     5 * @ingroup libfs
     6 */
     7
    18/*
    29 * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  • cpukit/libfs/src/defaults/default_open.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief RTEMS Default Filesystem - Default Open
     5 * @ingroup libfs
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 2010.
  • cpukit/libfs/src/defaults/default_readlink.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief RTEMS Default Filesystem - Default Readlink
     5 * @ingroup libfs
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 2010.
  • cpukit/libfs/src/defaults/default_rmnod.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief RTEMS Default Filesystem - Default Remove Node
     5 * @ingroup libfs
     6 */
     7
    18/*
    29 *  COPYRIGHT (c) 2010.
  • cpukit/libfs/src/dosfs/fat.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief Low-level Operations on a Volume with a DOSFS FAT filesystem
     5 * @ingroup libfs
     6 */
     7
    18/*
    2  * fat.c
    3  *
    4  * Low-level operations on a volume with FAT filesystem
    5  *
    69 * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
    710 * Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
  • cpukit/libfs/src/dosfs/msdos.h

    r36f3207 r4e59276  
    8181
    8282/**
    83  *  @brief Type of Node that Loc Refers To
     83 *  @brief Type of node that loc refers to.
    8484 *
    8585 *  The following returns the type of node that the loc refers to.
     
    234234
    235235/**
    236  *  @brief Shut Down MSDOS FileSystem
     236 *  @brief Shut down the MSDOS filesystem.
    237237 *
    238238 *  MSDOS shut down handler implementation
     
    243243
    244244/**
    245  *  @brief Call Fat-File Close Routine
     245 *  @brief Call the Fat-File close routine.
    246246 *
    247247 *  Free node handler implementation for the filesystem operations table.
     
    253253);
    254254
     255/**
     256 * @brief Routine for node creation in a MSDOS filesystem.
     257 *
     258 * MSDOS Directory Handlers Implementation
     259 */
    255260int msdos_mknod(
    256261  const rtems_filesystem_location_info_t *loc,
     
    262267
    263268/**
    264  * @brief Remove Node from MSDOS Directory
     269 * @brief Remove node from MSDOS directory.
    265270 *
    266271 * MSDOS Directory Handlers Implementation
     
    272277
    273278/**
    274  * @brief Rename a MSDOS FileSystem Node
     279 * @brief rename a MSDOS filesystem node
    275280 *
    276281 * Routine to rename a MSDOS filesystem node
     
    289294
    290295/**
    291  *  @brief MSDOS Filesystem Initialization
     296 *  @brief The MSDOS filesystem initialization.
    292297 *
    293298 *  MSDOS Initialization support routine implementation
     
    343348
    344349/**
    345  * @brief Implements wake up version of the "signal" operation
     350 * @brief Implements wake up version of the "signal" operation.
    346351 *
    347352 * Routine to create a new MSDOS filesystem node
  • cpukit/libfs/src/dosfs/msdos_eval.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief MSDOS Evaluation Routines
     5 * @ingroup libfs
     6 */
     7
    18/*
    2  *  MSDOS evaluation routines
    3  *
    49 *  Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
    510 *  Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
  • cpukit/libfs/src/dosfs/msdos_mknod.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief Routine for Node Creation in MSDOS Filesystem
     5 * @ingroup libfs_msdos MSDOS FileSystem
     6 */
     7
    18/*
    2  *  Routine for node creation in MSDOS filesystem.
    3  *
    49 *  Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia
    510 *  Author: Eugeny S. Mints <Eugeny.Mints@oktet.ru>
  • cpukit/libfs/src/nfsclient/proto/mount_prot.h

    r36f3207 r4e59276  
    99#include <rpc/rpc.h>
    1010
    11 
     11/**
     12 *  @defgroup libfs_nfsclient_mount_prot Mount Prot
     13 *
     14 *  @ingroup libfs
     15 */
     16/**@{*/
    1217#ifdef __cplusplus
    1318extern "C" {
     
    141146}
    142147#endif
    143 
     148/**@}*/
    144149#endif /* !_MOUNT_PROT_H_RPCGEN */
  • cpukit/libfs/src/nfsclient/proto/mount_prot_xdr.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief Mount Prot XDR
     5 * @ingroup libfs_nfsclient_mount_prot Mount Prot
     6 */
     7
    18/*
    29 * Please do not edit this file.
  • cpukit/libfs/src/nfsclient/proto/nfs_prot.h

    r36f3207 r4e59276  
    99#include <rpc/rpc.h>
    1010
    11 
     11/**
     12 *  @defgroup libfs_nfsclient_nfs_prot NFS Prot
     13 *
     14 *  @ingroup libfs
     15 */
     16/**@{*/
    1217#ifdef __cplusplus
    1318extern "C" {
     
    452457}
    453458#endif
    454 
     459/**@}*/
    455460#endif /* !_NFS_PROT_H_RPCGEN */
  • cpukit/libfs/src/nfsclient/proto/nfs_prot_xdr.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief NFS Prot XDR
     5 * @ingroup libfs_nfsclient_nfs_prot NFS Prot
     6 */
     7
    18/*
    29 * Please do not edit this file.
  • cpukit/libfs/src/nfsclient/src/cexphelp.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief CEXP Help Information
     5 * @ingroup libfs
     6 */
     7
    18#if HAVE_CONFIG_H
    29#include "config.h"
  • cpukit/libfs/src/nfsclient/src/dirutils.c

    r36f3207 r4e59276  
    1 /* very crude and basic fs utilities for testing the NFS */
    2 
    3 /* Till Straumann, <strauman@slac.stanford.edu>, 10/2002 */
     1/**
     2 * @file
     3 *
     4 * @brief Basic NFS Filesystem Utilities for Testing the NFS
     5 * @ingroup libfs
     6 */
    47
    58/*
     9 * Author: Till Straumann, <strauman@slac.stanford.edu>, 10/2002
     10 *
    611 * Authorship
    712 * ----------
  • cpukit/libfs/src/nfsclient/src/nfs.c

    r36f3207 r4e59276  
    1 /* NFS client implementation for RTEMS; hooks into the RTEMS filesystem */
    2 
    3 /* Author: Till Straumann <strauman@slac.stanford.edu> 2002 */
     1/**
     2 * @file
     3 *
     4 * @brief NFS Client Implementation for RTEMS
     5 * @ingroup libfs
     6 *
     7 * Hooks Into the RTEMS NFS Filesystem
     8 */
    49
    510/*
     11 * Author: Till Straumann <strauman@slac.stanford.edu>, 2002
     12 *
    613 * Hacked on by others.
    714 *
    815 * Modifications to support reference counting in the file system are
    916 * Copyright (c) 2012 embedded brains GmbH.
    10  */
    11 
    12 /*
     17 *
    1318 * Authorship
    1419 * ----------
     
    13141319
    13151320        memcpy(&psa->sin_addr, h->h_addr, sizeof (struct in_addr));
    1316  
     1321
    13171322  /* END OF NON-THREAD SAFE REGION */
    13181323
     
    17711776    return -1;
    17721777  }
    1773  
     1778
    17741779        nfsInit(0, 0);
    17751780
     
    17771782        printf("Trying to mount %s on %s\n",path,mntpoint);
    17781783#endif
    1779  
     1784
    17801785        if ( buildIpAddr(&uid, &gid, &host, &saddr, &path) )
    17811786                return -1;
  • cpukit/libfs/src/nfsclient/src/nfs.modini.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief NFS Module Initialize
     5 * @ingroup libfs
     6 */
     7
    18#if HAVE_CONFIG_H
    29#include "config.h"
  • cpukit/libfs/src/nfsclient/src/nfsTest.c

    r36f3207 r4e59276  
    1 /* Test program for evaluating NFS read throughput */
    2 
    3 /* Author: Till Straumann <strauman@slac.stanford.edu>, 2006 */
    4 
    5 /* This test code allows for evaluating NFS read performance
     1/**
     2 * @file
     3 *
     4 * @brief Test Program for Evaluating NFS Read Throughput
     5 * @ingroup libfs
     6 *
     7 * This test code allows for evaluating NFS read performance
    68 * under various scenarios:
    79 *  - synchronous reads with various buffer sizes (select
     
    4951 */
    5052
     53
     54
     55
    5156/*
     57 * Author: Till Straumann <strauman@slac.stanford.edu>, 2006
     58 *
    5259 * Authorship
    5360 * ----------
  • cpukit/libfs/src/nfsclient/src/rpcio.c

    r36f3207 r4e59276  
    1 /* RPC multiplexor for a multitasking environment */
    2 
    3 /* Author: Till Straumann <strauman@slac.stanford.edu>, 2002 */
    4 
    5 /* This code funnels arbitrary task's UDP/RPC requests
     1/**
     2 * @file
     3 *
     4 * @brief RPC Multiplexor for a Multitasking Environment
     5 * @ingroup libfs
     6 *
     7 * This code funnels arbitrary task's UDP/RPC requests
    68 * through one socket to arbitrary servers.
    79 * The replies are gathered and dispatched to the
     
    1618
    1719/*
     20 * Author: Till Straumann <strauman@slac.stanford.edu>, 2002
     21 *
    1822 * Authorship
    1923 * ----------
  • cpukit/libfs/src/nfsclient/src/rpcio.modini.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief RPCIO Module Initialize
     5 * @ingroup libfs
     6 */
     7
    18#if HAVE_CONFIG_H
    29#include "config.h"
  • cpukit/libfs/src/nfsclient/src/sock_mbuf.c

    r36f3207 r4e59276  
     1/**
     2 * @file
     3 *
     4 * @brief Sock Mbuf
     5 * @ingroup libfs
     6 */
     7
    18/*
    29 *  NOTE:
     
    1017 *    Licensing: 'LICENSE.NET' file in the RTEMS top source directory
    1118 *               for more information.
    12  */
    13 
    14 /*
    15 The RTEMS TCP/IP stack is a port of the FreeBSD TCP/IP stack.  The following
    16 copyright and licensing information applies to this code.
    17 
    18 This code is found under the c/src/libnetworking directory but does not
    19 constitute the entire contents of that subdirectory.
    20 
    21 =============================================================================
    22 
    23 Copyright (c) 1980, 1983, 1988, 1993
    24         The Regents of the University of California.  All rights reserved.
    25 
    26 Redistribution and use in source and binary forms, with or without
    27 modification, are permitted provided that the following conditions
    28 are met:
    29 1. Redistributions of source code must retain the above copyright
    30    notice, this list of conditions and the following disclaimer.
    31 2. Redistributions in binary form must reproduce the above copyright
    32    notice, this list of conditions and the following disclaimer in the
    33    documentation and/or other materials provided with the distribution.
    34 3. All advertising materials mentioning features or use of this software
    35    must display the following acknowledgment:
    36         This product includes software developed by the University of
    37         California, Berkeley and its contributors.
    38 4. Neither the name of the University nor the names of its contributors
    39    may be used to endorse or promote products derived from this software
    40    without specific prior written permission.
    41 
    42 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    43 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    44 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    45 ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    46 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    47 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    48 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    49 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    50 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    51 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    52 SUCH DAMAGE.
    53 
    54 -
    55 Portions Copyright (c) 1993 by Digital Equipment Corporation.
    56 
    57 Permission to use, copy, modify, and distribute this software for any
    58 purpose with or without fee is hereby granted, provided that the above
    59 copyright notice and this permission notice appear in all copies, and that
    60 the name of Digital Equipment Corporation not be used in advertising or
    61 publicity pertaining to distribution of the document or software without
    62 specific, written prior permission.
    63 
    64 THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
    65 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
    66 OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
    67 CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
    68 DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
    69 PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
    70 ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
    71 SOFTWARE.
    72 
    73 =============================================================================
    74 */
     19 *
     20 * The RTEMS TCP/IP stack is a port of the FreeBSD TCP/IP stack.  The following
     21 * copyright and licensing information applies to this code.
     22 *
     23 * This code is found under the c/src/libnetworking directory but does not
     24 * constitute the entire contents of that subdirectory.
     25 *
     26 *
     27 * Copyright (c) 1980, 1983, 1988, 1993
     28 *      The Regents of the University of California.  All rights reserved.
     29 *
     30 * Redistribution and use in source and binary forms, with or without
     31 * modification, are permitted provided that the following conditions
     32 * are met:
     33 * 1. Redistributions of source code must retain the above copyright
     34 *    notice, this list of conditions and the following disclaimer.
     35 * 2. Redistributions in binary form must reproduce the above copyright
     36 *    notice, this list of conditions and the following disclaimer in the
     37 *    documentation and/or other materials provided with the distribution.
     38 * 3. All advertising materials mentioning features or use of this software
     39 *    must display the following acknowledgment:
     40 *      This product includes software developed by the University of
     41 *      California, Berkeley and its contributors.
     42 * 4. Neither the name of the University nor the names of its contributors
     43 *    may be used to endorse or promote products derived from this software
     44 *    without specific prior written permission.
     45 *
     46 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     49 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     56 * SUCH DAMAGE.
     57
     58 * Portions Copyright (c) 1993 by Digital Equipment Corporation.
     59
     60 * Permission to use, copy, modify, and distribute this software for any
     61 * purpose with or without fee is hereby granted, provided that the above
     62 * copyright notice and this permission notice appear in all copies, and that
     63 * the name of Digital Equipment Corporation not be used in advertising or
     64 * publicity pertaining to distribution of the document or software without
     65 * specific, written prior permission.
     66
     67 * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
     68 * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
     69 * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
     70 * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
     71 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
     72 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
     73 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
     74 * SOFTWARE.
     75 */
    7576
    7677#if HAVE_CONFIG_H
  • cpukit/libfs/src/nfsclient/src/xdr_mbuf.c

    r36f3207 r4e59276  
    1 /* xdr_mbuf is derived from xdr_mem */
    2 
    3 /* Author (mbuf specifica): Till Straumann <strauman@slac.stanford.edu>, 10/2002 */
     1/**
     2 * @file
     3 *
     4 * @brief XDR Implementation Using mbuf Buffers
     5 * @ingroup libfs
     6 *
     7 * xdr_mbuf is derived from xdr_mem
     8 */
    49
    510/*
     11 * Author (mbuf specifica): Till Straumann <strauman@slac.stanford.edu>, 10/2002
     12 *
    613 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
    714 * unrestricted use provided that this legend is included on all tape
Note: See TracChangeset for help on using the changeset viewer.