Giter Club home page Giter Club logo

sql2doxygen's Introduction

sql2doxygen v0.2 [Alpha]
========================

Introduction
------------

Doxygen is a tool for generating documentation from source code and it
currently handles many languages either natively or through add-on filters.
This script is one such filter that transforms T-SQL into C-like code so that
Doxygen can then parse it natively. 

While this means that you can benefit from the automated generation of
documentation it does mean that you have to mentally translate a 'struct' back
into a 'table' and reverse the type and member/variable names in declarations.

Releases
--------

Stable releases are formally packaged and made available from my SQL tools page:
http://www.chrisoldwood.com/sql.htm

The latest code is available from my GitHub repo:
https://github.com/chrisoldwood/sql2doxygen

Documentation
-------------

There is a manual: sql2doxygen.html.

Contact Details
------------------

Email: [email protected]
Web:   http://www.chrisoldwood.com

Chris Oldwood 
31st January 2012

sql2doxygen's People

Contributors

chrisoldwood avatar

Stargazers

avatar avatar avatar avatar avatar

Watchers

avatar avatar

Forkers

quzardc

sql2doxygen's Issues

Minor Updates

Thank you for this wonderful script. Below please find a patch that updates some functionality of it. I was working from a scripted create of a table in MSSQL 2014 and wanted to make sure to handle all those things. Some of it is hacky (-er than the original) but it seems to output the example the same way.

Added:

  • 'set' commands are interpreted as defines. (my use cases have them only for environmental vars, perhaps static const would be better?)
  • trim out 'constraint' tags on table creates
  • deal with 'Identity ( )' on column defines

Additionally, I'm throwing in the note that to function with the newest doxygen (1.8) it is necessary to add "EXTENSION_MAPPING = sql=C++" to your config. Tracking this down took quite a bit of time as I'd not used doxygen plugins before.

sql2doxygen_patch.txt

sql2doxygen

Hi,
I tried this sql2doxygen and the examples are not working as expected.
I followed the procedure to configure and run as given in the below link.
http://www.chrisoldwood.com/wip/sql2doxygen/manual/sql2doxygen.html

sql file is not getting parsed.
HTML output i can see is only the sql file name
If i click it, it just displays file reference.

Can you please guide me and let me know if i need to change any other thing in config file please.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.