You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ibatis.apache.org by "Marko Lahma (JIRA)" <ib...@incubator.apache.org> on 2005/07/11 09:56:09 UTC

[jira] Created: (IBATISNET-90) Enable XML documentation file generation in Visual Studio project properties

Enable XML documentation file generation in Visual Studio project properties
----------------------------------------------------------------------------

         Key: IBATISNET-90
         URL: http://issues.apache.org/jira/browse/IBATISNET-90
     Project: iBatis for .NET
        Type: Improvement
  Components: Build  
    Reporter: Marko Lahma
    Priority: Minor


"XML Documentation File" field in [project properties] -> Configuration Properties -> Build should be set to corresponding documentation file that should be generated (Castle.DynamicProxy.xml). This also enables compile time warnings of bad documentation (missing comments etc). One another option is "Treat warnings as errors" to prevent developers from committing poorly documented code to version control ;-)

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Commented: (IBATISNET-90) Enable XML documentation file generation in Visual Studio project properties

Posted by "Marko Lahma (JIRA)" <ib...@incubator.apache.org>.
    [ http://issues.apache.org/jira/browse/IBATISNET-90?page=comments#action_12315469 ] 

Marko Lahma commented on IBATISNET-90:
--------------------------------------

And of course having this XML file in the same directory with the DLL enables intellisense in dependent projects.

> Enable XML documentation file generation in Visual Studio project properties
> ----------------------------------------------------------------------------
>
>          Key: IBATISNET-90
>          URL: http://issues.apache.org/jira/browse/IBATISNET-90
>      Project: iBatis for .NET
>         Type: Improvement
>   Components: Build
>     Reporter: Marko Lahma
>     Priority: Minor

>
> "XML Documentation File" field in [project properties] -> Configuration Properties -> Build should be set to corresponding documentation file that should be generated (Castle.DynamicProxy.xml). This also enables compile time warnings of bad documentation (missing comments etc). One another option is "Treat warnings as errors" to prevent developers from committing poorly documented code to version control ;-)

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Commented: (IBATISNET-90) Enable XML documentation file generation in Visual Studio project properties

Posted by "Gilles Bayon (JIRA)" <ib...@incubator.apache.org>.
    [ http://issues.apache.org/jira/browse/IBATISNET-90?page=comments#action_12315540 ] 

Gilles Bayon commented on IBATISNET-90:
---------------------------------------

No problem :-)

> Enable XML documentation file generation in Visual Studio project properties
> ----------------------------------------------------------------------------
>
>          Key: IBATISNET-90
>          URL: http://issues.apache.org/jira/browse/IBATISNET-90
>      Project: iBatis for .NET
>         Type: Improvement
>   Components: Build
>     Reporter: Marko Lahma
>     Assignee: Gilles Bayon
>     Priority: Minor
>      Fix For: DataMapper 1.3

>
> "XML Documentation File" field in [project properties] -> Configuration Properties -> Build should be set to corresponding documentation file that should be generated (Castle.DynamicProxy.xml). This also enables compile time warnings of bad documentation (missing comments etc). One another option is "Treat warnings as errors" to prevent developers from committing poorly documented code to version control ;-)

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


[jira] Closed: (IBATISNET-90) Enable XML documentation file generation in Visual Studio project properties

Posted by "Gilles Bayon (JIRA)" <ib...@incubator.apache.org>.
     [ http://issues.apache.org/jira/browse/IBATISNET-90?page=all ]
     
Gilles Bayon closed IBATISNET-90:
---------------------------------

    Fix Version: DataMapper 1.3
     Resolution: Incomplete
      Assign To: Gilles Bayon

CastleDynamic is not part of iBATIS.
And the Xml Documentation File properties are set in iBATIS projects.


> Enable XML documentation file generation in Visual Studio project properties
> ----------------------------------------------------------------------------
>
>          Key: IBATISNET-90
>          URL: http://issues.apache.org/jira/browse/IBATISNET-90
>      Project: iBatis for .NET
>         Type: Improvement
>   Components: Build
>     Reporter: Marko Lahma
>     Assignee: Gilles Bayon
>     Priority: Minor
>      Fix For: DataMapper 1.3

>
> "XML Documentation File" field in [project properties] -> Configuration Properties -> Build should be set to corresponding documentation file that should be generated (Castle.DynamicProxy.xml). This also enables compile time warnings of bad documentation (missing comments etc). One another option is "Treat warnings as errors" to prevent developers from committing poorly documented code to version control ;-)

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira