Commit e3bdf1b5 authored by Adrian Negreanu's avatar Adrian Negreanu
Browse files

sqlite3: update the comments 



Signed-off-by: default avatarAdrian Negreanu <groleo@gmail.com>
parent b7afd347

src/sqlite3gen.cpp

+47 −32
Original line number Original line Diff line number Diff line
@@ -343,6 +343,7 @@ static void writeInnerClasses(sqlite3*db,const ClassSDict *cl) 




static void writeInnerNamespaces(sqlite3 * /*db*/,const NamespaceSDict *nl)

static void writeInnerNamespaces(sqlite3 * /*db*/,const NamespaceSDict *nl)

{

{

#warning WorkInProgress

  if (nl)

  if (nl)

  {

  {

    NamespaceSDict::Iterator nli(*nl);

    NamespaceSDict::Iterator nli(*nl);
@@ -364,6 +365,7 @@ static void writeTemplateArgumentList(sqlite3* /*db*/, 
                                      FileDef * /*fileScope*/,

                                      FileDef * /*fileScope*/,

                                      int /*indent*/)

                                      int /*indent*/)

{

{

#warning WorkInProgress

}

}





static void writeTemplateList(sqlite3*db,ClassDef *cd)

static void writeTemplateList(sqlite3*db,ClassDef *cd)
@@ -490,15 +492,20 @@ static void generateSqlite3ForNamespace(sqlite3 *db, NamespaceDef *nd) 
  // + contained namespace definitions

  // + contained namespace definitions

  // + member groups

  // + member groups

  // + normal members

  // + normal members

  // + brief desc

  // - brief desc

  // + detailed desc

  // - detailed desc

  // + location

  // - location

  // - files containing (parts of) the namespace definition

  // - files containing (parts of) the namespace definition





  if (nd->isReference() || nd->isHidden()) return; // skip external references

  if (nd->isReference() || nd->isHidden()) return; // skip external references



  // + contained class definitions

  writeInnerClasses(db,nd->getClassSDict());

  writeInnerClasses(db,nd->getClassSDict());



  // + contained namespace definitions

  writeInnerNamespaces(db,nd->getNamespaceSDict());

  writeInnerNamespaces(db,nd->getNamespaceSDict());





  // + member groups

  if (nd->getMemberGroupSDict())

  if (nd->getMemberGroupSDict())

  {

  {

    MemberGroupSDict::Iterator mgli(*nd->getMemberGroupSDict());

    MemberGroupSDict::Iterator mgli(*nd->getMemberGroupSDict());
@@ -510,6 +517,7 @@ static void generateSqlite3ForNamespace(sqlite3 *db, NamespaceDef *nd) 
    }

    }

  }

  }





  // + normal members

  QListIterator<MemberList> mli(nd->getMemberLists());

  QListIterator<MemberList> mli(nd->getMemberLists());

  MemberList *ml;

  MemberList *ml;

  for (mli.toFirst();(ml=mli.current());++mli)

  for (mli.toFirst();(ml=mli.current());++mli)
@@ -526,16 +534,16 @@ static void generateSqlite3ForFile(sqlite3 *db, FileDef *fd) 
{

{

  // + includes files

  // + includes files

  // + includedby files

  // + includedby files

  // + include graph

  // - include graph

  // + included by graph

  // - included by graph

  // + contained class definitions

  // + contained class definitions

  // + contained namespace definitions

  // + contained namespace definitions

  // + member groups

  // + member groups

  // + normal members

  // + normal members

  // + brief desc

  // - brief desc

  // + detailed desc

  // - detailed desc

  // + source code

  // - source code

  // + location

  // - location

  // - number of lines

  // - number of lines





  if (fd->isReference()) return; // skip external references

  if (fd->isReference()) return; // skip external references
@@ -543,11 +551,13 @@ static void generateSqlite3ForFile(sqlite3 *db, FileDef *fd) 
  {

  {

    writeInnerClasses(db,fd->getClassSDict());

    writeInnerClasses(db,fd->getClassSDict());

  }

  }

  // + contained namespace definitions

  if (fd->getNamespaceSDict())

  if (fd->getNamespaceSDict())

  {

  {

    writeInnerNamespaces(db,fd->getNamespaceSDict());

    writeInnerNamespaces(db,fd->getNamespaceSDict());

  }

  }





  // + member groups

  if (fd->getMemberGroupSDict())

  if (fd->getMemberGroupSDict())

  {

  {

    MemberGroupSDict::Iterator mgli(*fd->getMemberGroupSDict());

    MemberGroupSDict::Iterator mgli(*fd->getMemberGroupSDict());
@@ -559,6 +569,7 @@ static void generateSqlite3ForFile(sqlite3 *db, FileDef *fd) 
    }

    }

  }

  }





  // + normal members

  QListIterator<MemberList> mli(fd->getMemberLists());

  QListIterator<MemberList> mli(fd->getMemberLists());

  MemberList *ml;

  MemberList *ml;

  for (mli.toFirst();(ml=mli.current());++mli)

  for (mli.toFirst();(ml=mli.current());++mli)
@@ -662,6 +673,7 @@ static void generateSqlite3ForMember(sqlite3*db,MemberDef *md,Definition *def) 
    bindIntParameter(i_s_memberdef,":raisable",md->isRaisable());

    bindIntParameter(i_s_memberdef,":raisable",md->isRaisable());

  }

  }





  // + declaration/definition arg lists

  if (md->memberType()!=MemberType_Define &&

  if (md->memberType()!=MemberType_Define &&

      md->memberType()!=MemberType_Enumeration

      md->memberType()!=MemberType_Enumeration

     )

     )
@@ -821,15 +833,13 @@ static void generateSqlite3ForMember(sqlite3*db,MemberDef *md,Definition *def) 
    }

    }

  }

  }







  step(db,i_s_memberdef);

  step(db,i_s_memberdef);

  /*int id_src =*/ sqlite3_last_insert_rowid(db);

  /*int id_src =*/ sqlite3_last_insert_rowid(db);





  // + cross-references

  // + source references

  // The cross-references in initializers only work when both the src and dst

  // The cross-references in initializers only work when both the src and dst

  // are defined.

  // are defined.

  MemberSDict *mdict = md->getReferencesMembers();

  MemberSDict *mdict = md->getReferencesMembers();

  // references

  if (mdict!=0)

  if (mdict!=0)

  {

  {

    MemberSDict::IteratorDict mdi(*mdict);

    MemberSDict::IteratorDict mdi(*mdict);
@@ -840,8 +850,8 @@ static void generateSqlite3ForMember(sqlite3*db,MemberDef *md,Definition *def) 
    }

    }

  }

  }





  // + source referenced by

  mdict = md->getReferencedByMembers();

  mdict = md->getReferencedByMembers();

  // referencedby

  if (mdict!=0)

  if (mdict!=0)

  {

  {

    MemberSDict::IteratorDict mdi(*mdict);

    MemberSDict::IteratorDict mdi(*mdict);
@@ -855,20 +865,20 @@ static void generateSqlite3ForMember(sqlite3*db,MemberDef *md,Definition *def) 




static void generateSqlite3ForClass(sqlite3 *db, ClassDef *cd)

static void generateSqlite3ForClass(sqlite3 *db, ClassDef *cd)

{

{

  // + brief description

  // + detailed description

  // + template argument list(s)

  // - include file

  // + member groups

  // + inheritance diagram

  // + list of direct super classes

  // + list of direct super classes

  // + list of direct sub classes

  // + list of direct sub classes

  // + include file

  // + list of inner classes

  // + list of inner classes

  // + collaboration diagram

  // - template argument list(s)

  // + member groups

  // + list of all members

  // + list of all members

  // + user defined member sections

  // - brief description

  // + standard member sections

  // - detailed description

  // + detailed member documentation

  // - inheritance DOT diagram

  // - collaboration DOT diagram

  // - user defined member sections

  // - standard member sections

  // - detailed member documentation

  // - examples using the class

  // - examples using the class





  if (cd->isReference())        return; // skip external references.

  if (cd->isReference())        return; // skip external references.
@@ -896,7 +906,7 @@ static void generateSqlite3ForClass(sqlite3 *db, ClassDef *cd) 




  step(db,i_s_compounddef);

  step(db,i_s_compounddef);





  // + basecompoundref

  // + list of direct super classes

  if (cd->baseClasses())

  if (cd->baseClasses())

  {

  {

    BaseClassListIterator bcli(*cd->baseClasses());

    BaseClassListIterator bcli(*cd->baseClasses());
@@ -920,7 +930,7 @@ static void generateSqlite3ForClass(sqlite3 *db, ClassDef *cd) 
    }

    }

  }

  }





  // + derivedcompoundref

  // + list of direct sub classes

  if (cd->subClasses())

  if (cd->subClasses())

  {

  {

    BaseClassListIterator bcli(*cd->subClasses());

    BaseClassListIterator bcli(*cd->subClasses());
@@ -936,8 +946,7 @@ static void generateSqlite3ForClass(sqlite3 *db, ClassDef *cd) 
    }

    }

  }

  }





  ///////////////////////////////////////////////////////////////////

  // + include file

  // INCLUDEINFO

  IncludeInfo *ii=cd->includeInfo();

  IncludeInfo *ii=cd->includeInfo();

  if (ii)

  if (ii)

  {

  {
@@ -958,10 +967,14 @@ static void generateSqlite3ForClass(sqlite3 *db, ClassDef *cd) 
      }

      }

    }

    }

  }

  }

  ///////////////////////////////////////////////////////////////////



  // + list of inner classes

  writeInnerClasses(db,cd->getClassSDict());

  writeInnerClasses(db,cd->getClassSDict());



  // - template argument list(s)

  writeTemplateList(db,cd);

  writeTemplateList(db,cd);





  // + member groups

  if (cd->getMemberGroupSDict())

  if (cd->getMemberGroupSDict())

  {

  {

    MemberGroupSDict::Iterator mgli(*cd->getMemberGroupSDict());

    MemberGroupSDict::Iterator mgli(*cd->getMemberGroupSDict());
@@ -973,6 +986,7 @@ static void generateSqlite3ForClass(sqlite3 *db, ClassDef *cd) 
    }

    }

  }

  }





  // + list of all members

  QListIterator<MemberList> mli(cd->getMemberLists());

  QListIterator<MemberList> mli(cd->getMemberLists());

  MemberList *ml;

  MemberList *ml;

  for (mli.toFirst();(ml=mli.current());++mli)

  for (mli.toFirst();(ml=mli.current());++mli)
@@ -991,10 +1005,11 @@ void generateSqlite3() 
  // + classes

  // + classes

  // + namespaces

  // + namespaces

  // + files

  // + files

  // - groups

  // + groups

  // - related pages

  // + related pages

  // - examples

  // + examples

  //QCString outputDirectory = Config_getString("SQLITE3_OUTPUT");

  // + main page



  QCString outputDirectory = Config_getString("OUTPUT_DIRECTORY");

  QCString outputDirectory = Config_getString("OUTPUT_DIRECTORY");

  QDir sqlite3Dir(outputDirectory);

  QDir sqlite3Dir(outputDirectory);

  sqlite3 *db;

  sqlite3 *db;