[gna-register] [task #1559] Submission of PALDAP: A Lazy Directory Administrator's

[Rowan Rodrik van der Molen]

Follow-up Comment #3, task #1559 (project admin):

I've apparently been too lax in putting copyright/licence statements where
they belong. I've hopefully fixed this now, but I'm not completely sure, so
before wasting your time with another wrong submission, I'll ask a question or
two.

With phpdoc comments it's a a habit to document files which contain only a
class definition in a manner like:

<?php

require_once('PALDAP/dn.php');

/**
 * This class represents the PALDAP application.
 *
 * @author Rowan Rodrik van der Molen <[EMAIL PROTECTED]>
 * @copyright Copyright &copy; 2003-2004 Rowan Rodrik van der Molen.
 * @license http://opensource.org/licenses/gpl-license.php GNU Public License

 */
class Net_PALDAP_App
{
    var $name = "PALDAP";
    var $slogan = "PALDAP: A Lazy Directory Administrator's Pal";
    var $version = "0.6.7";
}

?>

Include files with multiple classes and/or global functions are documented
using a comment at the top of the file, such that:

<?php
/**
 * Assorted functions and definitions.
 *
 * @author Rowan Rodrik van der Molen <[EMAIL PROTECTED]>
 * @copyright Copyright &copy; 2003-2004 Rowan Rodrik van der Molen.
 * @license http://opensource.org/licenses/gpl-license.php GNU Public
License
 */

function somefunction() {}

?>

The "<?php" string in these examples denotes the beginning of the file.

I have been under the impression for some time that these statements were
enough, but if they're not, I'm assuming I need to add the following to the
beginning of each file?

# This file is part of PALDAP.PHP.
#
# PALDAP.PHP 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 2 of the License, or
# (at your option) any later version.
#
# PALDAP.PHP 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 PALDAP; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


Oh. I've also added the file called COPYING with the full GPL text.

Thanks for your time, and forgive me my ignorance.
It's amazing that you treat me with such patience given that you must meet
such ignorance more often than you do not :-)

    _______________________________________________________

Reply to this item at:

  <http://gna.org/task/?func=detailitem&item_id=1559>

_______________________________________________
  Message sent via/by Gna!
  http://gna.org/