Fortran-FOSS-Programmers / Fortran-FOSS-Programmers/ford

Code citations in documentation page

Open
#228 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
458
Forks
138
PR merge metrics
No merged PRs in 30d

Description

I am new at FORD. I would like to know whether is possible to generate [code citations](https://cmacmackin.github.io/pages/fortran-tutorial.html) in the documentation, from comments in the source code instead of typing pieces of source code explicitly in a [markdown environment](https://github.com/cmacmackin/fortran-tutorial/blob/master/doc/notes.md#problem).

This feature is present in Doxygen, see this [example](https://www.dealii.org/8.5.0/doxygen/deal.II/step_1.html#Includefiles) with the following source [code](https://github.com/dealii/dealii/blob/master/examples/step-1/step-1.cc)

I am targeting something like:

The `do_stuff` subroutine:
```fortran
subroutine do_stuff(repeat)
```
Contains the following main loop:
```fortran
do i=1,repeat
global_pi = acos(-1)
end do
```
By commenting the code somehow similar to:
```fortran
!!The `do_stuff` subroutine:
!!@code
subroutine do_stuff(repeat)
!!@endcode
integer, intent(in) :: repeat
integer :: i
! non FORD comment
!! Contains the following main loop:
!!@code
do i=1,repeat
global_pi = acos(-1)
end do
!!@endcode
end subroutine do_stuff

```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.