Commits

Nathan Collier  committed 43d7caf

added doc generator (make doc from top level), fixes to source comments. Thanks to Monther Busbait.

  • Participants
  • Parent commits a0fe97f

Comments (0)

Files changed (6)

 	-@echo "Completed test"
 .PHONY: test test-build
 
+doc:
+	@if [ ! -d docs/html ]; then \
+	  mkdir docs/html; \
+	fi
+	-@${RM} docs/html/*.html
+
+	@${PETSC_DIR}/${PETSC_ARCH}/bin/doctext -mpath docs/html -html src/*.c
+
+	@#! /bin/sh
+	@echo '<TITLE>PetIGA Documentation</TITLE>' > docs/html/index.html 
+	@echo '<H1>PetIGA Documentation</H1>' >> docs/html/index.html
+	@echo '<MENU>' >> docs/html/index.html
+	@ls -1 docs/html | grep .html | grep -v index.html | sed -e 's%^\(.*\).html$$%<LI><A HREF="\1.html">\1</A>%g' >> docs/html/index.html
+	@echo '</MENU>' >> docs/html/index.html
 
 alletags:
 	-@${PYTHON} ${PETSC_DIR}/bin/maint/generateetags.py

File src/petiga.c

     }
     ierr = MPI_Comm_free(&cartcomm);CHKERRQ(ierr);
   }
-#endif /*PETSC_HAVE_MPIUNI*/
+#endif /* PETSC_HAVE_MPIUNI */
   PetscFunctionReturn(0);
 }
 

File src/petigaelem.c

   PetscInt dim = point->dim;
   PetscInt nsd = point->nsd;
   PetscInt index;
-  /*PetscValidPointer(element,1);*/
-  /*PetscValidPointer(point,2);*/
+  /* PetscValidPointer(element,1); */
+  /* PetscValidPointer(point,2); */
   /* */
   point->nvec = 0;
   point->nmat = 0;

File src/petigapce.c

   pc->ops->setup               = PCSetUp_EBE;
   pc->ops->reset               = PCReset_EBE;
   pc->ops->destroy             = PCDestroy_EBE;
-  pc->ops->setfromoptions      = 0;/*PCSetFromOptions_EBE;*/
+  pc->ops->setfromoptions      = 0;/* PCSetFromOptions_EBE; */
   pc->ops->view                = PCView_EBE;
   pc->ops->apply               = PCApply_EBE;
   pc->ops->applytranspose      = PCApplyTranspose_EBE;

File src/petigareg.c

 #define __FUNCT__ "IGAFinalizePackage"
 PetscErrorCode IGAFinalizePackage(void)
 {
-  /*PetscErrorCode ierr;*/
+  /* PetscErrorCode ierr; */
   PetscFunctionBegin;
   PetscFunctionReturn(0);
 }

File src/snesfdcolor.c

 #define __FUNCT__ "SNESSetFromOptions_FDColoring"
 PetscErrorCode SNESSetFromOptions_FDColoring(SNES snes)
 {
-  /*SNESAddOptionsChecker SNESSetFromOptions*/
+  /* SNESAddOptionsChecker SNESSetFromOptions */
   PetscBool      fdc = PETSC_FALSE;
   PetscErrorCode ierr;
   PetscFunctionBegin;