Archive

Archive for the ‘Documentation’ Category

New Online Documentation Release: R17

December 4, 2012 Leave a comment

New Online Documentation Release: R17

A new version (R17) of the product documentation was released!

This new version includes:

Additions:

    • New articles:
      • About Producers
      • Automatic Traces Producer
      • ASP.NET Web Site Producer V2

Updates:

  • Entire “Generating” chapter was updated to match how producers are named and organized in the Modeler,
  • Extra “See also” links on most of producer pages

As well as miscellaneous corrections as usual Smile

Interested in some extra articles?
Comment this post and let us what you’d like to see in the next release!

Categories: Documentation Tags:

New Online Documentation Release: R16

November 13, 2012 2 comments

A new version (R16) of the product documentation was released!

This new version includes:

Additions:

  • New articles:
    • MySQL Producer
    • PostgreSQL Producer
    • Importers: Configration parameters
    • Importing from MySQL
    • Importing from PostgreSQL
    • Importing from SQLite
    • Working with an existing database

Updates:

  • CodeFluent Entities
  • Introducing CodeFluent Entities
  • Migration and interoperability
  • Importing an existing database or model
  • Importing from Microsoft SQL Server
  • Importing from Microsoft SQL Server CE
  • Importing from Microsoft Access
  • Importing from Oracle Database
  • Importing from OLEDB
  • Importing from ADO.NET Entity Framework
  • Importing from Enterprise Architect
  • Importing from UML (XMI)

As well as miscellaneous corrections as usual Smile

Interested in some extra articles?
Comment this post and let us know what you’d like to see in the next release!

Categories: Documentation Tags:

New Online Documentation Release: R15

November 23, 2011 Leave a comment

A new version (R15) of the product documentation was released!

This new version includes:

Additions:

Updates:

  • Blob Cache

As well as miscellaneous corrections

Interested in some extra articles? Comment this post and tell us what you’d like to see in the next release!

PS: if you receive 404 errors or if the TOC don’t show when browsing this new documentation version, please reset your browser cache.

New Online Documentation Release: R12

September 20, 2011 Leave a comment

A new version (R12) of the product documentation was released!

This new version includes:

Additions:

  • New technical articles:
    • Generating Mobile-Enabled WCF Services Using CodeFluent Entities
    • Consuming Generated WCF Services in Android
    • Consuming Generated WCF Services in Windows Phone
    • Consuming Generated WCF Services in iOS
    • Creating A WPF Smart Client With Authentication Using CodeFluent Entities
    • Windows Workflow Foundation 4 and CodeFluent Entities
  • New tutorial:
    • Using the WPF Smart Client Producer
  • New article:
    • Hosting WCF Services

Updates:

  • Generating Text Files
  • Developing A Smart Client
  • Developing .NET Applications With Oracle Database
  • Importers articles
  • Developing Silverlight applications

As well as miscellaneous corrections and a new look :)

Interested in some extra articles? Comment this post and tell us what you’d like to see in the next release!

PS: if you receive 404 errors or if the TOC don’t show when browsing this new documentation version, please reset your browser cache.

New Online Documentation Release: R11


A new version (R11) of the product documentation was released!

This new version includes:

Interested in some extra articles? Comment this post and tell us what you’d like to see in the next release!

Generating Documentation

April 26, 2011 Leave a comment

CodeFluent Entities provides a documentation sub-producer which allows you to:

  • Decorate all members with XML comments (usable by Visual Studio IntelliSense and help tools),
  • Generate XML, batch and configuration files to create a .CHM documentation using Sandcastle.

To benefit from it, you first need to add an instance of the sub-producer. To do so, select the Business Object Model Producer instance of your project, right-click on it and select “Add New SubProducer”. Then in the “Add New SubProducer” dialog, select “Documentation” in the tree view and configure it:

DocumentationProducer

Note: the only required property is the “Sandcastle Target Directory “which needs to be specified so the producer knows where to generate its output files. If producing Sandcastle files, you need to have Sandcastle installed before generating and ensure the Sandcastle path is correct so you’ll be able to use the generated files right away.

Since decorating all members of all your generated classes all the time can be quite an overkill during developments, it is disabled by default in the Business Object Model producer, so you need to enable it as well. Double-click on your Business Object Model producer instance to open its configuration and set “Generate Xml Documentation” to “True”:

GenerateDocumentation

In the XML this looks like something like that:

<cf:producer typeName="CodeFluent.Producers.CodeDom.CodeDomProducer, CodeFluent.Producers.CodeDom">
  <cf:configuration targetDirectory="..\Sample" outputName="{0}.dll" generateDocumentation="true">
    <subProducer typeName="CodeFluent.Producers.Documentation.DocumentationProducer, CodeFluent.Producers.Documentation"
                 targetDirectory="..\Doc" sourceDirectory="%CF_TEMPLATES_PATH%\Documentation" />
  </cf:configuration>
</cf:producer>

Build over your project and you’ll see that all your members have XML remarks on them! Moreover, in the Sandcastle Target Directory you specified, you’ll see a set of files allowing you to generate a .CHM file documenting the generated objet model Smile

New Online Documentation Release: R10

March 17, 2011 Leave a comment

A new version (R10) of CodeFluent Entities’ documentation was released: http://www.codefluententities.com/documentation/

Extra technical articles were added:

Increased documentation on Search methods, and Array Parameters since CFQL now supports SQL Server 2008’s Table-Valued Types.

The CodeFluent Entities “Pattern” concept was renamed as “Aspect” to avoid confusion.

Documentation on producers was polished and new producer documentation articles were introduced, such as:

Talking about Azure, developers can now configure their application to use Windows Azure Blob Storage to store their blobs instead of storing them in database, and this was documented in a new article as well: Windows Azure Blob Storage.

Categories: Documentation
Follow

Get every new post delivered to your Inbox.

Join 49 other followers