Generating Documentation for complicated project structure - doxygen

I have a C project that is structured like so:
.
├── Makefile
├── c_kernels
│   ├── cuda
│   │   ├── Makefile
│   │ ├── kernel_interface.h
│   │   └── kernel.cu
│   ├── omp3
│   │   ├── Makefile
│   │ ├── kernel_interface.h
│   │   └── kernel.c
│   ├── omp4
│   │   ├── Makefile
│   │ ├── kernel_interface.h
│   │   └── kernel.c
│   ├── omp4_clang
│   │   ├── Makefile
│   │ ├── kernel_interface.h
│   │   └── kernel.c
│   └── serial
│      ├── Makefile
│   ├── kernel_interface.h
│      └── kernel.c
├── drivers
│      ├── Makefile
│   ├── kernel_interface.h
│      └── kernel_driver.c
├── kernel_interface.h
├── main.c
├── make.deps
└── make.flags
The makefile is configured so you would make the project like so (for omp3):
$ make KERNELS=omp3
How can I generate the Doxygen documentation for a project in this kind of structure for one type of kernel at a time?
Is it that I will need to have a Doxygen configuration for each kernel type?
Or should I add a docs build target in my makefile and then build the documentation based upon the target kernel?

Related

Install, with CPAN, Perl modules to specific directory when several appear in use [duplicate]

This question already has answers here:
How can I install a CPAN module into a local directory?
(5 answers)
Closed 4 years ago.
Running the following command returns several paths:
perl -e 'print join("\n",#INC,"")'
Every path has modules installed within. I would want to install modules, as root, into the following directory:
/usr/local/share/perl5
What commands would I run to find where cpan,as root, currently installs modules? How would I alter it if it is not the path shown above?
Here's how I have configured cpan to put all new modules in a specific directory:
o conf makepl_arg 'PREFIX=/usr/local/share/perl5 INSTALLMAN3DIR=/usr/local/share/perl5/man/man3'
o conf mbuild_arg '--install_base /usr/local/share/perl5'
o conf mbuild_install_arg '--install_base /usr/local/share/perl5'
o conf mbuildpl_arg '--install-base /usr/local/share/perl5'
[o conf commit]
The first line addresses modules that use ExtUtils::MakeMaker and the next three lines are for modules that use Module::Build.
You can also do this quite easily via App::cpm.
$ cpm install -L my-random-folder Open::This
DONE install Path-Tiny-0.108 (using prebuilt)
DONE install Try-Tiny-0.30 (using prebuilt)
DONE install Module-Build-0.4224 (using prebuilt)
DONE install Module-Runtime-0.016 (using prebuilt)
DONE install Open-This-0.000008 (using prebuilt)
5 distributions installed.
$ tree my-random-folder
my-random-folder
├── bin
│   ├── config_data
│   └── ot
└── lib
└── perl5
├── 5.26.1
│   └── darwin-2level
├── Module
│   ├── Build
│   │   ├── API.pod
│   │   ├── Authoring.pod
│   │   ├── Base.pm
│   │   ├── Bundling.pod
│   │   ├── Compat.pm
│   │   ├── Config.pm
│   │   ├── ConfigData.pm
│   │   ├── Cookbook.pm
│   │   ├── Dumper.pm
│   │   ├── Notes.pm
│   │   ├── PPMMaker.pm
│   │   ├── Platform
│   │   │   ├── Default.pm
│   │   │   ├── MacOS.pm
│   │   │   ├── Unix.pm
│   │   │   ├── VMS.pm
│   │   │   ├── VOS.pm
│   │   │   ├── Windows.pm
│   │   │   ├── aix.pm
│   │   │   ├── cygwin.pm
│   │   │   ├── darwin.pm
│   │   │   └── os2.pm
│   │   └── PodParser.pm
│   ├── Build.pm
│   └── Runtime.pm
├── Open
│   └── This.pm
├── Path
│   └── Tiny.pm
├── Try
│   └── Tiny.pm
└── darwin-2level
└── auto
├── Module
│   ├── Build
│   └── Runtime
├── Open
│   └── This
├── Path
│   └── Tiny
└── Try
└── Tiny

Unable to access Scala's Akka libraries in JRuby

I'm using jruby 1.7.12 (1.9.3p392) and I want to take advantage of the Scala Akka library. I'm aware of the Mikka gem, but I want to do this manually.
I've downloaded the Akka library "2.3.8" from http://akka.io/downloads/ (specifically the link "Akka 2.3.8 distribution for Scala 2.11").
Below is the file structure (one app.rb JRuby file and the rest is the downloaded Akka library)...
├── akka-2.3.8
| ├── bin
| ├── config
| ├── deploy
| ├── doc
│   ├── lib
│   │   ├── akka
│   │   │   ├── akka-actor_2.11-2.3.8.jar
│   │   │   ├── akka-agent_2.11-2.3.8.jar
│   │   │   ├── akka-camel_2.11-2.3.8.jar
│   │   │   ├── akka-cluster_2.11-2.3.8.jar
│   │   │   ├── akka-contrib_2.11-2.3.8.jar
│   │   │   ├── akka-dataflow_2.11-2.3.8.jar
│   │   │   ├── akka-durable-mailboxes-2.3.8.jar
│   │   │   ├── akka-file-mailbox_2.11-2.3.8.jar
│   │   │   ├── akka-kernel_2.11-2.3.8.jar
│   │   │   ├── akka-mailboxes-common_2.11-2.3.8.jar
│   │   │   ├── akka-multi-node-testkit_2.11-2.3.8.jar
│   │   │   ├── akka-persistence-experimental_2.11-2.3.8.jar
│   │   │   ├── akka-persistence-tck-experimental_2.11-2.3.8.jar
│   │   │   ├── akka-remote-tests_2.11-2.3.8.jar
│   │   │   ├── akka-remote_2.11-2.3.8.jar
│   │   │   ├── akka-slf4j_2.11-2.3.8.jar
│   │   │   ├── akka-testkit_2.11-2.3.8.jar
│   │   │   ├── akka-transactor_2.11-2.3.8.jar
│   │   │   ├── akka-zeromq_2.11-2.3.8.jar
│   │   │   ├── camel-core-2.10.3.jar
│   │   │   ├── config-1.2.1.jar
│   │   │   ├── guava-12.0.jar
│   │   │   ├── hamcrest-core-1.3.jar
│   │   │   ├── hawtjni-runtime-1.8.jar
│   │   │   ├── jna-3.0.9.jar
│   │   │   ├── jnr-constants-0.8.2.jar
│   │   │   ├── jsr305-1.3.9.jar
│   │   │   ├── junit-4.11.jar
│   │   │   ├── leveldb-0.5.jar
│   │   │   ├── leveldb-api-0.5.jar
│   │   │   ├── leveldbjni-1.7.jar
│   │   │   ├── leveldbjni-all-1.7.jar
│   │   │   ├── leveldbjni-linux32-1.5.jar
│   │   │   ├── leveldbjni-linux64-1.5.jar
│   │   │   ├── leveldbjni-osx-1.5.jar
│   │   │   ├── leveldbjni-win32-1.5.jar
│   │   │   ├── leveldbjni-win64-1.5.jar
│   │   │   ├── netty-3.8.0.Final.jar
│   │   │   ├── protobuf-java-2.5.0.jar
│   │   │   ├── scala-continuations-library_2.11-1.0.2.jar
│   │   │   ├── scala-reflect-2.11.0.jar
│   │   │   ├── scala-stm_2.11-0.7.jar
│   │   │   ├── scalatest_2.11-2.1.3.jar
│   │   │   ├── slf4j-api-1.7.5.jar
│   │   │   ├── uncommons-maths-1.2.2a.jar
│   │   │   └── zeromq-scala-binding_2.11-0.0.7-spark.jar
│   │   └── scala-library-2.11.4.jar
│   └── src
│   └── akka
│   ├── akka-actor_2.11-2.3.8-sources.jar
│   ├── akka-agent_2.11-2.3.8-sources.jar
│   ├── akka-camel_2.11-2.3.8-sources.jar
│   ├── akka-cluster_2.11-2.3.8-sources.jar
│   ├── akka-contrib_2.11-2.3.8-sources.jar
│   ├── akka-dataflow_2.11-2.3.8-sources.jar
│   ├── akka-durable-mailboxes-2.3.8-sources.jar
│   ├── akka-file-mailbox_2.11-2.3.8-sources.jar
│   ├── akka-kernel_2.11-2.3.8-sources.jar
│   ├── akka-mailboxes-common_2.11-2.3.8-sources.jar
│   ├── akka-multi-node-testkit_2.11-2.3.8-sources.jar
│   ├── akka-persistence-experimental_2.11-2.3.8-sources.jar
│   ├── akka-persistence-tck-experimental_2.11-2.3.8-sources.jar
│   ├── akka-remote-tests_2.11-2.3.8-sources.jar
│   ├── akka-remote_2.11-2.3.8-sources.jar
│   ├── akka-slf4j_2.11-2.3.8-sources.jar
│   ├── akka-testkit_2.11-2.3.8-sources.jar
│   ├── akka-transactor_2.11-2.3.8-sources.jar
│   └── akka-zeromq_2.11-2.3.8-sources.jar
└── app.rb
The contents of the app.rb file is...
require "java"
$CLASSPATH << "akka-2.3.8"
$: << File.join(File.dirname(__FILE__), "akka-2.3.8")
java_import java.lang.System
java_import "akka.actor.ActorRegistry"
java_import "akka.actor.Actors"
java_import "akka.actor.UntypedActor"
...I appreciate that (in JRuby) $CLASSPATH and the load path $: are mapped, but I thought I would try both.
Running app.rb causes the following error (importing java.lang.System is fine, the akka.actor.ActorRegistry is the first line that breaks)...
NameError: cannot load Java class akka.actor.ActorRegistry
for_name at org/jruby/javasupport/JavaClass.java:1250
get_proxy_class at org/jruby/javasupport/JavaUtilities.java:34
java_import at file:/Users/markmcdonnell/.rubies/jruby-1.7.12/lib/jruby.jar!/jruby/java/core_ext/object.rb:26
map at org/jruby/RubyArray.java:2409
java_import at file:/Users/markmcdonnell/.rubies/jruby-1.7.12/lib/jruby.jar!/jruby/java/core_ext/object.rb:22
(root) at size.rb:7
What is the problem here. Have I not downloaded the right files or am I not referencing them properly?
Maybe the << does not add all the individual jars to the classpath? You might have to look for something else to include all jars in lib and lib/akka. Unfortunately I don't know enough JRuby to tell you how to do it.
Also: you are importing classes (ActorRegistry, Actors) that don't exist in Akka 2.3.8. Please check the latest API docs, and make sure you are not trying an Akka 1.x example (as ActorRegistry would indicate).
So, the following seems to work, maybe you can use that as a starting point:
require "java"
$CLASSPATH << "akka-2.3.8/lib/scala-library-2.11.4.jar"
$CLASSPATH << "akka-2.3.8/lib/akka/akka-actor_2.11-2.3.8.jar"
$CLASSPATH << "akka-2.3.8/lib/akka/config-1.2.1.jar"
java_import java.lang.System
java_import "akka.actor.ActorRef"
java_import "akka.actor.ActorSystem"
java_import "akka.actor.Props"
java_import "akka.actor.UntypedActor"

Game_ cannot be resolved to a variable in arquillian persistance example

I was asking on #arquillian Freenode IRC channel about question
Arquillian JPA tutorial: Could not create new instance of class org.jboss.arquillian.test.impl.EventTestRunnerAdaptor
when a user told me that he successfully runned
https://github.com/arquillian/arquillian-examples/tree/master/arquillian-persistence-tutorial
so I did
git clone https://github.com/arquillian/arquillian-examples.git
then in Eclipse, I clicked File->Import->Existing Maven Projects and selecte the subdirectory
arquillian-examples/arquillian-persistence-tutorial
Once Eclipse finished importing the project, I obtain in file
/src/test/java/org/arquillian/example/GamePersistenceTest.java
line 146, the error message
Game_ cannot be resolved to a variable
What can I do? In my attempt at the link at beginning of the page, this did not happpen.
I did not change any file downloaded from git repo.
Folder tree
.
├── pom.xml
├── src
│   ├── main
│   │   ├── java
│   │   │   └── org
│   │   │   └── arquillian
│   │   │   └── example
│   │   │   └── Game.java
│   │   └── resources
│   │   └── META-INF
│   │   └── persistence.xml
│   └── test
│   ├── java
│   │   └── org
│   │   └── arquillian
│   │   └── example
│   │   └── GamePersistenceTest.java
│   ├── resources
│   │   ├── arquillian.launch
│   │   ├── arquillian.xml
│   │   └── jbossas-ds.xml
│   ├── resources-glassfish-embedded
│   │   ├── glassfish-resources.xml
│   │   ├── logging.properties
│   │   └── test-persistence.xml
│   ├── resources-glassfish-remote
│   │   └── test-persistence.xml
│   └── resources-jbossas-managed
│   └── test-persistence.xml
└── target
├── classes
│   ├── META-INF
│   │   ├── MANIFEST.MF
│   │   ├── maven
│   │   │   └── org.arquillian.example
│   │   │   └── arquillian-persistence-tutorial
│   │   │   ├── pom.properties
│   │   │   └── pom.xml
│   │   └── persistence.xml
│   └── org
│   └── arquillian
│   └── example
│   └── Game.class
└── test-classes
├── arquillian.launch
├── arquillian.xml
├── glassfish-resources.xml
├── jbossas-ds.xml
├── logging.properties
├── org
│   └── arquillian
│   └── example
│   └── GamePersistenceTest.class
└── test-persistence.xml
30 directories, 24 files
The _Game class in that example is generated by the Hibernate JPA 2 metamodel generator (hibernate-jpamodelgen) that is defined as a dependency in the project POM. You'll now need to generate the metamodel by employing one the options outlined in the metamodel generator reference guide.
You could use Eclipse itself by configuring the annotation processing phase. Or you could modify the POM to use the maven-compiler-plugin configuration specified in the guide, to run as part of your build.

Which folders are unnecessary while deploying a play! app?

I have finally made a production worthy app with play, and use the play war -o foo command to create an exploded war. However, its size goes on to 30 MB and there are a lot of folders included. I develop in eclipse, so there are some eclipse folders too. Below is a list of the folders I have. Can anyone help me out with the unnecessary folders? I have zeroed in on the app, conf, public and lib folders. Is my assumption correct?
├── app
│   ├── controllers
│   ├── jobs
│   │   ├── daily
│   │   └── monthly
│   ├── models
│   │   ├── encrypt
│   │   ├── file
│   │   ├── login
│   │   └── mail
│   ├── playground
│   └── views
│   ├── Application
│   └── errors
├── conf
├── eclipse
│   └── classes
│   ├── controllers
│   ├── jobs
│   │   ├── daily
│   │   └── monthly
│   ├── models
│   │   ├── encrypt
│   │   ├── file
│   │   ├── login
│   │   └── mail
│   └── playground
├── lib
├── logs
├── public
│   ├── bootstrap
│   │   ├── css
│   │   ├── img
│   │   ├── js
│   │   │   └── tests
│   │   │   ├── unit
│   │   │   └── vendor
│   │   └── less
│   ├── images
│   ├── javascripts
│   └── stylesheets
├── test
└── tmp
├── bytecode
│   └── DEV
└── classes
├── controllers
├── helpers
├── jobs
│   ├── daily
│   └── monthly
├── models
│   ├── encrypt
│   ├── file
│   ├── login
│   └── mail
└── playground
You need to delete your tmp folder as well, try to use play clean on your project.
All folders in app, conf, lib and public should be kept in your war. Maybe should add precompiled

Lift: Comet component not found / Class not found

For my first steps into Lift I just started with this tutorial but it won't work for me. Instead of the simple chat app I only get these two exceptions:
Error processing snippet: comet
Reason: Comet Component not found
and
Error processing snippet: ChatIn
Reason: Class Not Found
Here is the directory structure of my compiled webapp:
target/chat-1.0-SNAPSHOT/
├── index.html
├── META-INF
└── WEB-INF
├── classes
│   └── code
│   ├── comet
│   │   ├── Chat$$anonfun$lowPriority$1.class
│   │   ├── Chat.class
│   │   ├── ChatServer$$anonfun$lowPriority$1.class
│   │   ├── ChatServer.class
│   │   └── ChatServer$.class
│   └── snippet
│   ├── ChatIn$$anonfun$render$1.class
│   ├── ChatIn.class
│   └── ChatIn$.class
├── lib
│   ├── activation-1.1.jar
│   ├── commons-codec-1.4.jar
│   ├── commons-fileupload-1.2.2.jar
│   ├── derby-10.7.1.1.jar
│   ├── h2-1.2.147.jar
│   ├── htmlparser-1.2.1.jar
│   ├── joda-time-1.6.2.jar
│   ├── lift-actor_2.9.0-2.4-M3.jar
│   ├── lift-common_2.9.0-2.4-M3.jar
│   ├── lift-db_2.9.0-2.4-M3.jar
│   ├── lift-json_2.9.0-2.4-M3.jar
│   ├── lift-mapper_2.9.0-2.4-M3.jar
│   ├── lift-proto_2.9.0-2.4-M3.jar
│   ├── lift-util_2.9.0-2.4-M3.jar
│   ├── lift-webkit_2.9.0-2.4-M3.jar
│   ├── mail-1.4.4.jar
│   ├── paranamer-2.3.jar
│   ├── scala-compiler-2.9.0.jar
│   ├── scala-library-2.9.0.jar
│   ├── scalap-2.9.0.jar
│   └── slf4j-api-1.6.1.jar
└── web.xml
But as you can see, there are the compiled .class files for Chat, ChatServer and ChatIn, so what's wrong?
Please bring this question to the Lift Google group: https://groups.google.com/forum/#!forum/liftweb
It's likely that your Boot.scala doesn't contain the correct information, but without the source, it's tough to figure out the issue.