Thread overview | |||||||
---|---|---|---|---|---|---|---|
|
June 27, 2010 [phobos] License formatting | ||||
---|---|---|---|---|
| ||||
I'm seeing this at the beginning of Phobos files: /** * ... * License: <a href="http://www.boost.org/LICENSE_1_0.txt">Boost License 1.0</a>. * Authors: XYZ * * Copyright Digital Mars 2005 - 2009. * Distributed under the Boost Software License, Version 1.0. * (See accompanying file LICENSE_1_0.txt or copy at * http://www.boost.org/LICENSE_1_0.txt) */ I don't think we need two mentions of the license, and oftentimes the text appears poorly formatted in the actual doc. I'm thinking of: /** * ... * License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0). * Authors: XYZ * * Copyright Digital Mars 2005-. */ I'm using the WEB macro to allow non-html doc generation later on, and also am eliminating the closing year from the copyright. Walter - does this work? I'm preemptively doing this formatting on all files I touch. Andrei |
June 27, 2010 [phobos] License formatting | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | Wouldn't it be better to use the DDoc "Copyright" section?
/**
* ...
* License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0).
* Authors: XYZ
* Copyright: Digital Mars 2005-.
*/
-Lars
On Sun, 2010-06-27 at 11:51 -0500, Andrei Alexandrescu wrote:
> I'm seeing this at the beginning of Phobos files:
>
> /**
> * ...
> * License: <a href="http://www.boost.org/LICENSE_1_0.txt">Boost
> License 1.0</a>.
> * Authors: XYZ
> *
> * Copyright Digital Mars 2005 - 2009.
> * Distributed under the Boost Software License, Version 1.0.
> * (See accompanying file LICENSE_1_0.txt or copy at
> * http://www.boost.org/LICENSE_1_0.txt)
> */
>
> I don't think we need two mentions of the license, and oftentimes the text appears poorly formatted in the actual doc. I'm thinking of:
>
> /**
> * ...
> * License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0).
> * Authors: XYZ
> *
> * Copyright Digital Mars 2005-.
> */
>
> I'm using the WEB macro to allow non-html doc generation later on, and also am eliminating the closing year from the copyright.
>
> Walter - does this work? I'm preemptively doing this formatting on all files I touch.
>
>
> Andrei
> _______________________________________________
> phobos mailing list
> phobos at puremagic.com
> http://lists.puremagic.com/mailman/listinfo/phobos
|
June 27, 2010 [phobos] License formatting | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | We're following the format outlined in the boost docs.
On Jun 27, 2010, at 9:51 AM, Andrei Alexandrescu wrote:
> I'm seeing this at the beginning of Phobos files:
>
> /**
> * ...
> * License: <a href="http://www.boost.org/LICENSE_1_0.txt">Boost License 1.0</a>.
> * Authors: XYZ
> *
> * Copyright Digital Mars 2005 - 2009.
> * Distributed under the Boost Software License, Version 1.0.
> * (See accompanying file LICENSE_1_0.txt or copy at
> * http://www.boost.org/LICENSE_1_0.txt)
> */
>
> I don't think we need two mentions of the license, and oftentimes the text appears poorly formatted in the actual doc. I'm thinking of:
>
> /**
> * ...
> * License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0).
> * Authors: XYZ
> *
> * Copyright Digital Mars 2005-.
> */
>
> I'm using the WEB macro to allow non-html doc generation later on, and also am eliminating the closing year from the copyright.
>
> Walter - does this work? I'm preemptively doing this formatting on all files I touch.
>
>
> Andrei
> _______________________________________________
> phobos mailing list
> phobos at puremagic.com
> http://lists.puremagic.com/mailman/listinfo/phobos
|
June 27, 2010 [phobos] License formatting | ||||
---|---|---|---|---|
| ||||
Posted in reply to Sean Kelly | I don't understand. What docs are you referring to?
Andrei
On 06/27/2010 03:28 PM, Sean Kelly wrote:
> We're following the format outlined in the boost docs.
>
> On Jun 27, 2010, at 9:51 AM, Andrei Alexandrescu wrote:
>
>> I'm seeing this at the beginning of Phobos files:
>>
>> /**
>> * ...
>> * License:<a href="http://www.boost.org/LICENSE_1_0.txt">Boost License 1.0</a>.
>> * Authors: XYZ
>> *
>> * Copyright Digital Mars 2005 - 2009.
>> * Distributed under the Boost Software License, Version 1.0.
>> * (See accompanying file LICENSE_1_0.txt or copy at
>> * http://www.boost.org/LICENSE_1_0.txt)
>> */
>>
>> I don't think we need two mentions of the license, and oftentimes the text appears poorly formatted in the actual doc. I'm thinking of:
>>
>> /**
>> * ...
>> * License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0).
>> * Authors: XYZ
>> *
>> * Copyright Digital Mars 2005-.
>> */
>>
>> I'm using the WEB macro to allow non-html doc generation later on, and also am eliminating the closing year from the copyright.
>>
>> Walter - does this work? I'm preemptively doing this formatting on all files I touch.
>>
>>
>> Andrei
>> _______________________________________________
>> phobos mailing list
>> phobos at puremagic.com
>> http://lists.puremagic.com/mailman/listinfo/phobos
>
> _______________________________________________
> phobos mailing list
> phobos at puremagic.com
> http://lists.puremagic.com/mailman/listinfo/phobos
|
June 27, 2010 [phobos] License formatting | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | http://www.boost.org/users/license.html Sent from my iPhone On Jun 27, 2010, at 2:17 PM, Andrei Alexandrescu <andrei at erdani.com> wrote: > I don't understand. What docs are you referring to? > > Andrei > > On 06/27/2010 03:28 PM, Sean Kelly wrote: >> We're following the format outlined in the boost docs. >> >> On Jun 27, 2010, at 9:51 AM, Andrei Alexandrescu wrote: >> >>> I'm seeing this at the beginning of Phobos files: >>> >>> /** >>> * ... >>> * License:<a href="http://www.boost.org/LICENSE_1_0.txt">Boost License 1.0</a>. >>> * Authors: XYZ >>> * >>> * Copyright Digital Mars 2005 - 2009. >>> * Distributed under the Boost Software License, Version 1.0. >>> * (See accompanying file LICENSE_1_0.txt or copy at >>> * http://www.boost.org/LICENSE_1_0.txt) >>> */ >>> >>> I don't think we need two mentions of the license, and oftentimes the text appears poorly formatted in the actual doc. I'm thinking of: >>> >>> /** >>> * ... >>> * License: $(WEB boost.org/LICENSE_1_0.txt, Boost License 1.0). >>> * Authors: XYZ >>> * >>> * Copyright Digital Mars 2005-. >>> */ >>> >>> I'm using the WEB macro to allow non-html doc generation later on, and also am eliminating the closing year from the copyright. >>> >>> Walter - does this work? I'm preemptively doing this formatting on all files I touch. >>> >>> >>> Andrei >>> _______________________________________________ >>> phobos mailing list >>> phobos at puremagic.com >>> http://lists.puremagic.com/mailman/listinfo/phobos >> >> _______________________________________________ >> phobos mailing list >> phobos at puremagic.com >> http://lists.puremagic.com/mailman/listinfo/phobos |
Copyright © 1999-2021 by the D Language Foundation