Permalink
Browse files

moving to single, merged documentation file

  • Loading branch information...
jkowalski committed Jun 11, 2010
1 parent eb21b5c commit c454054d3494a973a6d863bcfbfbbdf0e24a6c42
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Topics>
- <Topic id="2fed9fc2-10bb-4cba-8cf7-3d370e77db27" visible="True" title="Welcome to NLog" />
- <Topic id="39d89cbf-c4ef-4266-a9c9-1db54996c3b5" visible="True" title="Logging Configuration">
- <Topic id="c997f699-77ad-4632-8c1d-8334ce6c6c9c" visible="True" title="Configuration File">
- <Topic id="b52ad5cd-1562-4905-91dc-febe86d2e310" visible="True" title="Targets">
- <Topic id="15697271-dda9-4cf2-9bf7-1a3c03124242" visible="True" title="Available Targets" />
- </Topic>
- <Topic id="d68a2254-68f5-4f0e-b396-e000d241272e" visible="True" title="Layout Renderers">
- <Topic id="5b1724af-ff7c-49b8-b7d5-5799eddc9243" visible="True" title="Available Layout Renderers" />
- </Topic>
- <Topic id="02c80428-3b7a-4c97-8847-e86c8078614f" visible="True" title="Layouts">
- <Topic id="a01a5a9f-10a1-4306-bbbc-3d74320551a1" visible="True" title="Available Layouts" />
- </Topic>
- <Topic id="ab757bb2-fc77-4001-954a-0ea766146b5a" visible="True" title="Filters">
- <Topic id="7ee80460-1e25-413c-aed6-d247aa3ba9d2" visible="True" title="Available Filters" />
- </Topic>
- <Topic id="a1af6025-8f77-46d9-9916-ca055ad5d0a3" visible="True" title="Conditions">
- <Topic id="deabf7ae-72fe-4691-8d00-230d0eff6e9f" visible="True" title="Available Conditions" />
- </Topic>
- <Topic id="4f980688-d01e-49ff-86f4-ecb07966f544" visible="True" title="Include Files" />
- </Topic>
- <Topic id="53e4b2cb-aac1-4d17-8a3b-55b145bf57ba" visible="True" title="Configuration API" />
- <Topic id="711d7e64-66c8-40cd-b473-0219a924fcc9" visible="True" title="Simple Configuration API" />
- </Topic>
- <Topic id="c53cc1f7-e684-4819-835a-d801b9d6bbd0" visible="True" title="How To" />
- <Topic id="76ee0d34-55e1-49f4-b8a0-a9ec62a1d4ed" visible="True" title="Glossary" />
- <Topic id="9dad0554-211b-4528-94f3-8fe060878fce" visible="True" title="Visual Studio Integration" />
-</Topics>
@@ -0,0 +1,29 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+ <PropertyGroup>
+ <DotNet4RefPath Condition="'$(DotNet4RefPath)' == ''">$(ProgramFiles)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0</DotNet4RefPath>
+ </PropertyGroup>
+
+ <ItemGroup>
+ <RefFile Include="$(DotNet4RefPath)\mscorlib.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.ServiceModel.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.Xml.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.Windows.Forms.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.Data.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.Drawing.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.Configuration.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.Runtime.Serialization.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.Web.dll" />
+ <RefFile Include="$(DotNet4RefPath)\System.Messaging.dll" />
+ </ItemGroup>
+
+ <!-- copy referenced assemblies to the output path temporarily -->
+ <Target Name="BeforeBuildHelp">
+ <Copy SourceFiles="@(RefFile)" DestinationFolder="$(NLogBuildPath)" />
+ </Target>
+
+ <!-- delete them after the help has been built -->
+ <Target Name="AfterBuildHelp">
+ <Delete Files="@(RefFile -> '$(NLogBuildPath)\%(Filename)%(Extension)')" />
+ </Target>
+</Project>
View
@@ -66,46 +66,62 @@
<Preliminary>True</Preliminary>
<NamespaceSummaries>
<NamespaceSummaryItem name="NLog" isDocumented="True" xmlns="">
- NLog namespace contains classes used by instrumented application to output log messages.
+ Contains classes used by instrumented application to output log messages.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Internal" isDocumented="True" xmlns="">
+ Components used internally for NLog.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Config" isDocumented="True" xmlns="">
+ Provides APIs to configure logging.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Targets" isDocumented="True" xmlns="">
+ Contains implementation of log targets.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Targets.Wrappers" isDocumented="True" xmlns="">
+ Contains implementation of wrapper targets.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Filters" isDocumented="True" xmlns="">
+ Contains implementation of filters.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Layouts" isDocumented="True" xmlns="">
+ Contains implementation of layouts.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.LayoutRenderers" isDocumented="True" xmlns="">
+ Contains implementation of layout renderers.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.LayoutRenderers.Wrappers" isDocumented="True" xmlns="">
+ Contains implementation of wrapper layout renderers.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Conditions" isDocumented="True" xmlns="">
+ Contains implementation of conditions used to filter log events.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Common" isDocumented="True" xmlns="">
+ Contains common components used when implementing NLog extensions.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.ComInterop" isDocumented="True" xmlns="">
+ COM Interop classes.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.LogReceiverService" isDocumented="True" xmlns="">
+ WCF proxy classes for implementing clients and servers of log receiver service.
+ </NamespaceSummaryItem>
+ <NamespaceSummaryItem name="NLog.Web" isDocumented="True" xmlns="">
+ Integration with ASP.NET.
</NamespaceSummaryItem>
</NamespaceSummaries>
<PlugInConfigurations>
</PlugInConfigurations>
<NamingMethod>MemberName</NamingMethod>
- <ProjectSummary>TODO: Project Summary</ProjectSummary>
+ <ProjectSummary>
+ </ProjectSummary>
<HelpFileFormat>HtmlHelp1, Website</HelpFileFormat>
+ <SyntaxFilters>CSharp, VisualBasic, VisualBasicUsage</SyntaxFilters>
</PropertyGroup>
<!-- There are no properties for these two groups but they need to appear in
order for Visual Studio to perform the build. -->
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
</PropertyGroup>
- <ItemGroup>
- <ContentLayout Include="Content Layout.content" />
- </ItemGroup>
- <ItemGroup>
- <None Include="available-conditions.aml" />
- <None Include="available-filters.aml" />
- <None Include="available-layouts.aml" />
- <None Include="available-layout-renderers.aml" />
- <None Include="available-targets.aml" />
- <None Include="visual-studio.aml" />
- <None Include="include-files.aml" />
- <None Include="variables.aml" />
- <None Include="filters.aml" />
- <None Include="conditions.aml" />
- <None Include="layouts.aml" />
- <None Include="layout-renderers.aml" />
- <None Include="targets.aml" />
- <None Include="simple-configuration-api.aml" />
- <None Include="configuration-api.aml" />
- <None Include="configuration-file.aml" />
- <None Include="configuration.aml" />
- <None Include="how-to.aml" />
- <None Include="introduction.aml" />
- <None Include="glossary.aml" />
- </ItemGroup>
<!-- Import the SHFB build targets -->
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
<Import Project="Frameworks\$(Framework).shfbproj" Condition="Exists('Frameworks\$(Framework).shfbproj')" />
@@ -1,82 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<topic id="deabf7ae-72fe-4691-8d00-230d0eff6e9f" revisionNumber="1">
- <developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
- <!--
- <summary>
- <para>Optional summary abstract</para>
- </summary>
- -->
- <introduction>
- <!-- Uncomment this to generate an outline of the section and sub-section
- titles. Specify a numeric value as the inner text to limit it to
- a specific number of sub-topics when creating the outline. Specify
- zero (0) to limit it to top-level sections only. -->
- <!-- <autoOutline /> -->
- <para>Required introduction</para>
- </introduction>
- <!-- Add one or more top-level section elements. These are collapsible.
- If using <autoOutline />, add an address attribute to identify it
- and specify a title so that it can be jumped to with a hyperlink. -->
- <section address="Section1">
- <title>Optional section title</title>
- <content>
- <!-- Uncomment this to create a sub-section outline
- <autoOutline /> -->
- <para>Add one or more sections with content</para>
- </content>
- <!-- If a section contains a sections element, its content creates
- sub-sections. These are not collapsible.
- <sections>
- <section address="SubSection1">
- <title>Sub-section 1</title>
- <content>
- <para>Sub-section content.</para>
- </content>
- </section>
- <section address="SubSection2">
- <title>Sub-section 2</title>
- <content>
- <para>Sub-section content.</para>
- </content>
- </section>
- </sections> -->
- </section>
- <relatedTopics>
- <!-- One or more of the following:
- - A local link
- - An external link
- - A code entity reference
-
- <link xlink:href="Other Topic's ID"/>
- <link xlink:href="Other Topic's ID">Link inner text</link>
-
- <externalLink>
- <linkText>Link text</linkText>
- <linkAlternateText>Optional alternate link text</linkAlternateText>
- <linkUri>URI</linkUri>
- </externalLink>
-
- <codeEntityReference>API member ID</codeEntityReference>
-
- Examples:
-
- <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
- <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
-
- <externalLink>
- <linkText>SHFB on CodePlex</linkText>
- <linkAlternateText>Go to CodePlex</linkAlternateText>
- <linkUri>http://shfb.codeplex.com</linkUri>
- </externalLink>
-
- <codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
- <codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
- -->
- </relatedTopics>
- </developerConceptualDocument>
-</topic>
@@ -1,82 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<topic id="7ee80460-1e25-413c-aed6-d247aa3ba9d2" revisionNumber="1">
- <developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
- <!--
- <summary>
- <para>Optional summary abstract</para>
- </summary>
- -->
- <introduction>
- <!-- Uncomment this to generate an outline of the section and sub-section
- titles. Specify a numeric value as the inner text to limit it to
- a specific number of sub-topics when creating the outline. Specify
- zero (0) to limit it to top-level sections only. -->
- <!-- <autoOutline /> -->
- <para>Required introduction</para>
- </introduction>
- <!-- Add one or more top-level section elements. These are collapsible.
- If using <autoOutline />, add an address attribute to identify it
- and specify a title so that it can be jumped to with a hyperlink. -->
- <section address="Section1">
- <title>Optional section title</title>
- <content>
- <!-- Uncomment this to create a sub-section outline
- <autoOutline /> -->
- <para>Add one or more sections with content</para>
- </content>
- <!-- If a section contains a sections element, its content creates
- sub-sections. These are not collapsible.
- <sections>
- <section address="SubSection1">
- <title>Sub-section 1</title>
- <content>
- <para>Sub-section content.</para>
- </content>
- </section>
- <section address="SubSection2">
- <title>Sub-section 2</title>
- <content>
- <para>Sub-section content.</para>
- </content>
- </section>
- </sections> -->
- </section>
- <relatedTopics>
- <!-- One or more of the following:
- - A local link
- - An external link
- - A code entity reference
-
- <link xlink:href="Other Topic's ID"/>
- <link xlink:href="Other Topic's ID">Link inner text</link>
-
- <externalLink>
- <linkText>Link text</linkText>
- <linkAlternateText>Optional alternate link text</linkAlternateText>
- <linkUri>URI</linkUri>
- </externalLink>
-
- <codeEntityReference>API member ID</codeEntityReference>
-
- Examples:
-
- <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
- <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
-
- <externalLink>
- <linkText>SHFB on CodePlex</linkText>
- <linkAlternateText>Go to CodePlex</linkAlternateText>
- <linkUri>http://shfb.codeplex.com</linkUri>
- </externalLink>
-
- <codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
- <codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
- <codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
- -->
- </relatedTopics>
- </developerConceptualDocument>
-</topic>
Oops, something went wrong.

0 comments on commit c454054

Please sign in to comment.